調用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"}]}}]}}

錯誤碼

訪問錯誤中心查看更多錯誤碼。