You can call this operation to query the running status of a cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeClusterStatus

The operation that you want to perform. Set the value to DescribeClusterStatus.
ClusterId String Yes cds-bp1b136j****5d59

The ID of the cluster.

Response parameters

Parameter Type Example Description
CreatedTime String 2020-02-26T01:30:40Z

The time when the cluster was created. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC and denoted by Z.

RequestId String 3AC5F451-8B0F-47B4-9733-4A09C8838AD4

The ID of the request.
Status String Running

The running status of the cluster. Valid values:

  • Creating
  • CreateFailed
  • Running
  • Deleting
  • DeleteFailed
  • Deleted

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeClusterStatus
&ClusterId=cds-bp1b136j****5d59
&<Common request parameters>

Sample success responses

XML format 

<DescribeClusterStatusResponse>
  <Status>Running</Status>
  <CreatedTime>2020-02-26T01:30:40Z</CreatedTime>
  <RequestId>BEEDFA38-213F-4DF8-810D-702DFF5FF2A6</RequestId>
</DescribeClusterStatusResponse>

JSON format 

{
  "Status": "Running",
  "CreatedTime": "2020-02-26T01:30:40Z",
  "RequestId": "BEEDFA38-213F-4DF8-810D-702DFF5FF2A6"
}

Error codes

For a list of error codes, visit the API Error Center.