Queries the details of a single data center.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeDataCenter |
The operation that you want to perform. Set the value to DescribeDataCenter. |
ClusterId | String | Yes | cds-t4n98w89z77***** |
The ID of the cluster. |
DataCenterId | String | Yes | ap-southeast-1a |
The ID of the data center. You can call the DescribeDataCenters operation to query the corresponding data center ID. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
AutoRenewPeriod | Integer | 1 |
The payment period. The value of the AutoRenewPeriod parameter is available if the value of the PayType parameter is Subscription and the value of the AutoRenewal parameter is true. Unit: month. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, and 36. |
AutoRenewal | Boolean | true |
Specifies whether to enable auto-renewal. The values are available only when the PayType parameter is set to Subscription. Valid values: true: enables auto-renewal. false: disables auto-renewal. |
ClusterId | String | cds-t4n98w89z77***** |
The ID of the cluster. |
CommodityInstance | String | cds-t4n98w89z77***** |
The ID of the commodity instance. |
CreatedTime | String | 2020-10-16T11:27:20Z |
The time when the cluster was created. The time is in the HH:mmZ format. The time is displayed in UTC and denoted by Z. |
DataCenterId | String | ap-southeast-1a |
The ID of the data center in the cluster. |
DataCenterName | String | test_name |
The name of the data center in the cluster. |
DiskSize | Integer | 160 |
The size of the disk per node. Unit: GB. |
DiskType | String | cloud_ssd |
The storage type of the disk. Examples of valid values: cloud_ssd: SSD cloud_essd: enhanced SSD (ESSD) cloud_efficiency: ultra disk local_ssd_pro: local SSD |
ExpireTime | String | 2020-11-17T00:00:00Z |
The time when the cluster subscription expires. The time is in the HH:mmZ format. The time is displayed in UTC and denoted by Z. |
InstanceType | String | cassandra.c.large |
The cluster instance type. Some examples of valid values: cassandra.c.large: 2 cores, 4 GB cassandra.c.xlarge: 4 cores, 8 GB cassandra.c.2xlarge: 8 cores, 16 GB |
LockMode | String | None |
The lock mode. Valid values: None: The cluster is not locked. Expired: The cluster is locked upon expiration of subscription. DiskFull: The cluster is locked because the disk is full. |
NodeCount | Integer | 2 |
The number of nodes. |
PayType | String | Subscription |
The billing method of the cluster. Valid values: Subscription PayAsYouGo <note>Pay-as-you-go instances never expire.</note> |
RegionId | String | ap-southeast-1 |
The region ID. You can call the DescribeRegions operation to query available region IDs. |
RequestId | String | A4C83BDF-1DE0-41CD-9D6C-8D9FE5EB5504 |
The ID of the request. |
Status | String | Running |
The running status of the cluster. Some examples of valid values: Creating: The cluster is being created. CreateFailed: The cluster failed to be created. Running: The cluster is running. Deleting: The cluster is being deleted. DeleteFailed: The cluster failed to be deleted. Deleted: The cluster is deleted. |
VpcId | String | vpc-bp1qitxqe1m5r****4mng |
The ID of the virtual private cloud (VPC) network. |
VswitchId | String | vsw-bp13e9ynz3jpy****hqlm |
The ID of the vSwitch. |
ZoneId | String | ap-southeast-1a |
The zone ID of the instance that you want to create. You can call the DescribeRegions operation to query zones. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=DescribeDataCenter
&ClusterId=cds-t4n98w89z77*****
&DataCenterId=ap-southeast-1a
&<Common request parameters>
Sample success responses
XML
format
<AutoRenewPeriod>1</AutoRenewPeriod>
<Status>Running</Status>
<DataCenterId>ap-southeast-1a</DataCenterId>
<CommodityInstance>cds-t4n98w89z77*****</CommodityInstance>
<CreatedTime>2020-10-16T11:27:20Z</CreatedTime>
<NodeCount>2</NodeCount>
<ZoneId>ap-southeast-1a</ZoneId>
<RequestId>A4C83BDF-1DE0-41CD-9D6C-8D9FE5EB5504</RequestId>
<ClusterId>cds-t4n98w89z77*****</ClusterId>
<LockMode>None</LockMode>
<PayType>Subscription</PayType>
<VswitchId>vsw-bp13e9ynz3jpy****hqlm</VswitchId>
<DataCenterName>test_name</DataCenterName>
<DiskType>cloud_ssd</DiskType>
<AutoRenewal>true</AutoRenewal>
<VpcId>vpc-bp1qitxqe1m5r****4mng</VpcId>
<DiskSize>160</DiskSize>
<RegionId>ap-southeast-1</RegionId>
<ExpireTime>2020-11-17T00:00:00Z</ExpireTime>
<InstanceType>cassandra.c.large</InstanceType>
JSON
format
{"AutoRenewPeriod":"1","Status":"Running","DataCenterId":"ap-southeast-1a","CommodityInstance":"cds-t4n98w89z77*****","CreatedTime":"2020-10-16T11:27:20Z","NodeCount":"2","ZoneId":"ap-southeast-1a","RequestId":"A4C83BDF-1DE0-41CD-9D6C-8D9FE5EB5504","ClusterId":"cds-t4n98w89z77*****","LockMode":"None","PayType":"Subscription","VswitchId":"vsw-bp13e9ynz3jpy****hqlm","DataCenterName":"test_name","DiskType":"cloud_ssd","AutoRenewal":"true","VpcId":"vpc-bp1qitxqe1m5r****4mng","DiskSize":"160","RegionId":"ap-southeast-1","ExpireTime":"2020-11-17T00:00:00Z","InstanceType":"cassandra.c.large"}
Error codes
For a list of error codes, visit the API Error Center.