All Products
Search
Document Center

AnalyticDB for MySQL:DescribeDBClusterStatus

Last Updated:Apr 23, 2024

Queries the status of AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters within a region.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.

string

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