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.
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 |
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. |
This example shows you it is necessary to display the status of the cluster and the progress of operations.
POST / HTTP/1.1
Host: cdwdoris.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstanceState
<Common request parameters>
{
"InstanceId": "cdwch-exs8Mnql"
}
{
"Response": {
"InstanceState": "Serving",
"InstanceStateDesc": "Running",
"FlowCreateTime": "",
"FlowName": "",
"FlowProgress": 0,
"FlowMsg": "Failed to create progress",
"RequestId": "xxxx-xxxx-xxxx-xxxx"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.
本页内容是否解决了您的问题?