Queries all the clusters in a specified region.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeClusters |
The operation that you want to perform. Set the value to DescribeClusters. |
RegionId | String | No | cn-hangzhou |
The ID of the region, such as cn-hangzhou. |
PageNumber | Integer | No | 1 |
The page number of the page to return. Valid values: a positive integer. Default value: 1. |
PageSize | Integer | No | 20 |
The number of entries to return on each page. |
Tag.N.Key | String | No | key |
The key of custom tag N. |
Tag.N.Value | String | No | value |
The value of custom tag N. |
ClusterName | String | No | test |
The name of the cluster. |
ResourceGroupId | String | No | rg-xxxxxxxxx |
The ID of the resource group. You can view the available resource groups in the Resource Management console. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Clusters | Array of Cluster |
The list of cluster query results. |
|
Cluster | |||
AutoRenewPeriod | Integer | 12 |
The period of the auto-renewal.
Note This return value is unavailable if the billing method is Pay-as-you-go.
|
AutoRenewal | Boolean | true |
Specifies whether to enable auto-renewal. Valid values: true or false. Note This return value is unavailable if the billing method is Pay-as-you-go.
|
ClusterId | String | cds-bp1e4e32****z75c |
The ID of the cluster. |
ClusterName | String | Cassandra-test |
The name of the cluster. |
CreatedTime | String | 2019-09-20T16:02:34Z |
The time when the cluster was created. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC and denoted by Z. |
DataCenterCount | Integer | 1 |
The number of data centers. |
ExpireTime | String | 2019-10-20T16:02:34Z |
The expiration time of the cluster. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC and denoted by Z. Note Pay-as-you-go instances never expire.
|
LockMode | String | None |
The lock mode. Valid values:
|
MajorVersion | String | 3.11 |
The major version number. |
MinorVersion | String | 3.11.5 |
The minor version number. |
PayType | String | PayAsYouGo |
The billing method. Valid values:
Note Pay-as-you-go instances never expire.
|
ResourceGroupId | String | rg-xxxxxxxxxxx |
The ID of the resource group to which the resource belongs. |
Status | String | Running |
The running status of the cluster. Examples of valid values:
|
Tags | Array of Tag |
The tag. |
|
Tag | |||
Key | String | test-key |
The tag key. |
Value | String | test-value |
The tag value. |
PageNumber | Integer | 1 |
The page number of the page to return. Valid values: a positive integer. Default value: 1. |
PageSize | Integer | 10 |
The number of entries returned on each page. |
RequestId | String | 4EA95B55-58AB-469E-BD8E-5B1F9EEB1683 |
The ID of the request. |
TotalCount | Long | 3 |
The total number of clusters returned. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=DescribeClusters
&<Common request parameters>
Sample success responses
XML
format
<DescribeClustersResponse>
<TotalCount>1</TotalCount>
<RequestId>4EA95B55-58AB-469E-BD8E-5B1F9EEB1683</RequestId>
<PageSize>10</PageSize>
<PageNumber>1</PageNumber>
<Clusters>
<Cluster>
<Status>Running</Status>
<MajorVersion>3.11</MajorVersion>
<AutoRenewPeriod>12</AutoRenewPeriod>
<CreatedTime>2019-09-20T16:02:34Z</CreatedTime>
<AutoRenewal>true</AutoRenewal>
<ClusterId>cds-bp1e4e32****z75c</ClusterId>
<DataCenterCount>1</DataCenterCount>
<ClusterName>Cassandra-test</ClusterName>
<MinorVersion>3.11.5</MinorVersion>
<PayType>PayAsYouGo</PayType>
<LockMode>None</LockMode>
<ExpireTime>2019-10-20T16:02:34Z</ExpireTime>
</Cluster>
<Cluster>
<Tags>
<Tag>
<Value>test-value</Value>
<Key>test-key</Key>
</Tag>
</Tags>
</Cluster>
</Clusters>
</DescribeClustersResponse>
JSON
format
{"TotalCount":"3","RequestId":"4EA95B55-58AB-469E-BD8E-5B1F9EEB1683","PageSize":"10","PageNumber":"1","Clusters":{"Cluster":[{"Status":"Running","MajorVersion":"3.11","AutoRenewPeriod":"12","CreatedTime":"2019-09-20T16:02:34Z","AutoRenewal":"true","ClusterId":"cds-bp1e4e32****z75c","DataCenterCount":"1","ClusterName":"Cassandra-test","MinorVersion":"3.11.5","PayType":"PayAsYouGo","LockMode":"None","ExpireTime":"2019-10-20T16:02:34Z"},{"Tags":{"Tag":[{"Value":"test-value","Key":"test-key"}]}}]}}
Error codes
For a list of error codes, visit the API Error Center.