調用DescribeCluster查詢Cassandra實例的詳細信息。

調試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數

名稱 類型 是否必選 示例值 描述
Action String 是 DescribeCluster

系統規定參數。取值：DescribeCluster。
ClusterId String 是 cds-bp1b136j****5d58

集群 ID。

返回數據

名稱 類型 示例值 描述
Cluster Struct

集群信息列表。
AutoRenewPeriod Integer 12

自動續費周期。

  • 按月購買：則自動續費周期為 1 個月。
  • 按年購買：則自動續費周期為 1 年（12個月）。
說明 按量付費實例無到期時間
AutoRenewal Boolean true

是否自動續費，可取值：true/false

說明 按量付費實例無到期時間
ClusterId String cds-bp1b136j****5d56

集群ID。
ClusterName String Cassandra-test

集群名稱。

長度為2-128個字符，以大小寫字母或中文開頭，可包含數字，‘.’，‘_’或‘-’。
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來標識）。
IsLatestVersion Boolean true

當前小版本是否為最新版本。
LockMode String None

鎖定模式：

  • None：未鎖定
  • Expired：集群訂閱到期鎖定
  • DiskFull：磁盤已滿鎖定
MaintainEndTime String 4:00Z

實例運維結束時間。格式：HH:mmZ（UTC 通用標準時，以Z來標識）。
MaintainStartTime String 2:00Z

實例運維開始時間。格式：HH:mmZ（UTC 通用標準時，以Z來標識）。
MajorVersion String 3.11

集群主版本號。
MinorVersion String 3.11.7

集群小版本號。
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

標簽值
RequestId String 17E2B462-5FD3-4A0C-AF13-225C66E47BD5

請求ID。

示例

請求示例

http(s)://[Endpoint]/?Action=DescribeCluster
&ClusterId=cds-bp1b136j****5d58
&<公共請求參數>

正常返回示例

XML 格式 

<RequestId>17E2B462-5FD3-4A0C-AF13-225C66E47BD5</RequestId>
<Cluster>
    <Status>Running</Status>
    <MajorVersion>3.11</MajorVersion>
    <AutoRenewPeriod>12</AutoRenewPeriod>
    <CreatedTime>2019-09-20T16:02:34Z</CreatedTime>
    <ClusterId>cds-bp1b136j****5d56</ClusterId>
    <MinorVersion>3.11.7</MinorVersion>
    <PayType>PayAsYouGo</PayType>
    <LockMode>None</LockMode>
    <IsLatestVersion>true</IsLatestVersion>
    <MaintainEndTime>4:00Z</MaintainEndTime>
    <AutoRenewal>true</AutoRenewal>
    <DataCenterCount>1</DataCenterCount>
    <ClusterName>Cassandra-test</ClusterName>
    <ExpireTime>2019-10-20T16:02:34Z</ExpireTime>
    <MaintainStartTime>2:00Z</MaintainStartTime>
    <ResourceGroupId>rg-xxxxxxxxxxx</ResourceGroupId>
    <Tags>
        <Tag>
            <Value>test-value</Value>
            <Key>test-key</Key>
        </Tag>
    </Tags>
</Cluster>

JSON 格式 

{
    "RequestId": "17E2B462-5FD3-4A0C-AF13-225C66E47BD5",
    "Cluster": {
        "Status": "Running",
        "MajorVersion": 3.11,
        "AutoRenewPeriod": 12,
        "CreatedTime": "2019-09-20T16:02:34Z",
        "ClusterId": "cds-bp1b136j****5d56",
        "MinorVersion": "3.11.7",
        "PayType": "PayAsYouGo",
        "LockMode": "None",
        "IsLatestVersion": true,
        "MaintainEndTime": "4:00Z",
        "AutoRenewal": true,
        "DataCenterCount": 1,
        "ClusterName": "Cassandra-test",
        "ExpireTime": "2019-10-20T16:02:34Z",
        "MaintainStartTime": "2:00Z",
        "ResourceGroupId": "rg-xxxxxxxxxxx",
        "Tags": {
            "Tag": {
                "Value": "test-value",
                "Key": "test-key"
            }
        }
    }
}

錯誤碼

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