You can call this operation to query data center information.

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 DescribeDataCenters

The operation that you want to perform. Set the value to DescribeDataCenters.

ClusterId String Yes cds-bp1b136j****5d57

The ID of the cluster.

Response parameters

Parameter Type Example Description
DataCenters Array

The list of data centers.

DataCenter
ClusterId String cds-bp1syjlt****q976

The ID of the cluster.

CommodityInstance String cds-bp1syjlt****q976

The ID of the commodity instance.

CreatedTime String 2019-09-20T16:02:34Z

The time when the cluster was created. The time is in the HH:mmZ format, displayed in UTC and denoted by Z.

DataCenterId String cn-hangzhou-g

The ID of the data center in the cluster.

DataCenterName String test

The name of the data center in the cluster.

DiskSize Integer 22,000

The size of the disk per node. Unit: GB.

DiskType String local_ssd_pro

The type of the disk. Valid values:

  • cloud_ssd: standard SSD
  • cloud_essd: enhanced SSD (ESSD)
  • cloud_efficiency: ultra disk
  • local_ssd_pro: local SSD
ExpireTime String 2020-03-22T00:00:00Z

The expiration time of the cluster. The time is in the HH:mmZ format, displayed in UTC and denoted by Z.

InstanceType String cassandra.c5.xlarge

The instance type. 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. Valid values:

  • Subscription
  • PayAsYouGo

<note>Pay-as-you-go instances never expire.</note>

RegionId String cn-hangzhou

The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.

Status String Running

The running status of the cluster. Valid values:

  • Creating
  • CreateFailed
  • Running
  • Deleting
  • DeleteFailed
  • Deleted
VpcId String vpc-bp1qitxqe1m5r****4mng

The ID of the VPC.

VswitchId String vsw-bp13e9ynz3jpy****hqlm

The ID of the VSwitch.

ZoneId String cn-hangzhou-g

The ID of the zone in which the instance is created. You can call the DescribeRegions operation to query the most recent zone list.

RequestId String C8CA4D25-47FE-47D9-A34F-69B554A3A069

The ID of the request.

Examples

Sample requests

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

Sample success responses

XML format

<DescribeDataCentersResponse>
  <DataCenters>
        <DataCenter>
              <Status>Running</Status>
              <DataCenterId>cn-hangzhou-g</DataCenterId>
              <CreatedTime>2020-02-21T10:29:45Z</CreatedTime>
              <CommodityInstance>cds-bp1syjlt****q976</CommodityInstance>
              <ZoneId>cn-hangzhou-g</ZoneId>
              <NodeCount>2</NodeCount>
              <ClusterId>cds-bp1syjlt****q976</ClusterId>
              <PayType>Subscription</PayType>
              <LockMode>None</LockMode>
              <DataCenterName>test</DataCenterName>
              <VswitchId>vsw-bp1nm66r36goq****2thl</VswitchId>
              <DiskType>local_ssd_pro</DiskType>
              <VpcId>vpc-bp120k6ixs4eo****vu6x</VpcId>
              <DiskSize>22000</DiskSize>
              <RegionId>cn-hangzhou</RegionId>
              <InstanceType>cassandra.c.2xlarge</InstanceType>
              <ExpireTime>2020-03-22T00:00:00Z</ExpireTime>
        </DataCenter>
  </DataCenters>
  <RequestId>5AA67458-E8E8-419C-873A-D211CE2C7D31</RequestId>
</DescribeDataCentersResponse>

JSON format

{
  "DataCenters": {
    "DataCenter": [
      {
        "Status": "Running",
        "DataCenterId": "cn-hangzhou-g",
        "CreatedTime": "2020-02-21T10:29:45Z",
        "CommodityInstance": "cds-bp1syjlt****q976",
        "ZoneId": "cn-hangzhou-g",
        "NodeCount": 2,
        "ClusterId": "cds-bp1syjlt****q976",
        "PayType": "Subscription",
        "LockMode": "None",
        "DataCenterName": "test",
        "VswitchId": "vsw-bp1nm66r36goq****2thl",
        "DiskType": "local_ssd_pro",
        "VpcId": "vpc-bp120k6ixs4eo****vu6x",
        "DiskSize": 22000,
        "RegionId": "cn-hangzhou",
        "InstanceType": "cassandra.c.2xlarge",
        "ExpireTime": "2020-03-22T00:00:00Z"
      }
    ]
  },
  "RequestId": "5AA67458-E8E8-419C-873A-D211CE2C7D31"
}

Error codes

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