调用DescribeClusters查询指定地域下的所有集群信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeClusters

系统规定参数。取值：DescribeClusters。
RegionId String 否 cn-hangzhou

地域ID，如cn-hangzhou。
PageNumber Integer 否 1

页码，取值：大于0且不超过Integer的最大值。

默认值：1。
PageSize Integer 否 20

每页记录数。
Tag.N.Key String 否 key

自定义标签key
Tag.N.Value String 否 value

自定义标签value
ClusterName String 否 test

集群名称
ResourceGroupId String 否 rg-xxxxxxxxx

资源组Id，可在资源组控制台查看可用资源组。

返回数据

名称 类型 示例值 描述
Clusters Array of Cluster

集群查询结果列表。
Cluster
AutoRenewPeriod Integer 12

自动续费周期。

  • 按月购买：则自动续费周期为 1 个月。
  • 按年购买：则自动续费周期为 1 年（12个月）。
说明 按量付费实例无此返回值
AutoRenewal Boolean true

是否自动续费，可取值：true/false

说明 按量付费实例无此返回值
ClusterId String cds-bp1e4e32****z75c

集群ID。
ClusterName String Cassandra-test

集群名称。
CreatedTime String 2019-09-20T16:02:34Z

集群创建时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 通用标准时，以Z来标识）。
DataCenterCount Integer 1

数据中心个数。
ExpireTime String 2019-10-20T16:02:34Z

集群到期时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 通用标准时，以Z来标识）。

说明 按量付费实例无到期时间
LockMode String None

锁定模式。

  • None：未锁定
  • Expired：集群订阅到期锁定
  • DiskFull：磁盘已满锁定
MajorVersion String 3.11

主版本号。
MinorVersion String 3.11.5

小版本号。
PayType String PayAsYouGo

付费类型，可取值：

  • Subscription：包年包月
  • PayAsYouGo：按量付费
说明 按量付费实例无到期时间
ResourceGroupId String rg-xxxxxxxxxxx

资源所在的资源组id。
Status String Running

集群运行状态，取值示例：

  • Creating：创建中
  • CreateFailed：创建失败
  • Running：运行中
  • Deleting：删除中
  • DeleteFailed：删除失败
  • Deleted：已删除
Tags Array of Tag

标签
Tag
Key String test-key

标签键
Value String test-value

标签值
PageNumber Integer 1

页码，取值：大于0且不超过Integer的最大值。

默认值：1。
PageSize Integer 10

每页记录数。
RequestId String 4EA95B55-58AB-469E-BD8E-5B1F9EEB1683

请求ID。
TotalCount Long 3

查询集群总记录数。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeClusters
&<公共请求参数>

正常返回示例

XML 格式 

<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 格式 

{"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"}]}}]}}

错误码

访问错误中心查看更多错误码。