All Products
Search
Document Center

AnalyticDB:DescribeDBClusterStatus

Last Updated:Jan 24, 2025

Queries the status of AnalyticDB for MySQL Data Warehouse Edition clusters within a region.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the cluster.

Note You can call the DescribeRegions operation to query the most recent region list.
cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

Statusarray

The status of clusters.

Statusstring

The status of clusters. Valid values:

  • Preparing
  • Creating
  • Restoring
  • Running
  • Deleting
  • ClassChanging
  • NetAddressCreating
  • NetAddressDeleting
  • NetAddressModifying
  • EngineVersionUpgrading
["Preparing","Creating","Restoring","Running","Deleting","ClassChanging","NetAddressCreating","NetAddressDeleting","NetAddressModifying","EngineVersionUpgrading"]
RequestIdstring

The request ID.

1AD222E9-E606-4A42-BF6D-8A4442913CEAU

Examples

Sample success responses

JSONformat

{
  "Status": [
    "[\"Preparing\",\"Creating\",\"Restoring\",\"Running\",\"Deleting\",\"ClassChanging\",\"NetAddressCreating\",\"NetAddressDeleting\",\"NetAddressModifying\",\"EngineVersionUpgrading\"]"
  ],
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEAU"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history