tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeInstanceState

Last updated: 2024-08-30 14:34:42

1. API Description

Domain name for API request: cdwdoris.tencentcloudapi.com.

This API is used to display cluster status, process progress, etc. in the cluster details page.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeInstanceState.
Version Yes String Common Params. The value used for this API: 2021-12-28.
Region No String Common Params. This parameter is not required for this API.
InstanceId Yes String Cluster instance name

3. Output Parameters

Parameter Name Type Description
InstanceState String Cluster status. Example: Serving
FlowCreateTime String Creation time of cluster operation
Note: This field may return null, indicating that no valid values can be obtained.
FlowName String Cluster operation name
Note: This field may return null, indicating that no valid values can be obtained.
FlowProgress Float Cluster operation progress
Note: This field may return null, indicating that no valid values can be obtained.
InstanceStateDesc String Cluster status description. Example: running
Note: This field may return null, indicating that no valid values can be obtained.
FlowMsg String Cluster process error messages, such as "Creation failed, insufficient resources"
Note: This field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Getting Cluster Status

This example shows you it is necessary to display the status of the cluster and the progress of operations.

Input Example

POST / HTTP/1.1
Host: cdwdoris.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstanceState
<Common request parameters>

{
    "InstanceId": "cdwch-exs8Mnql"
}

Output Example

{
    "Response": {
        "InstanceState": "Serving",
        "InstanceStateDesc": "Running",
        "FlowCreateTime": "",
        "FlowName": "",
        "FlowProgress": 0,
        "FlowMsg": "Failed to create progress",
        "RequestId": "xxxx-xxxx-xxxx-xxxx"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy