调用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:按量付费
说明 按量付费实例无到期时间
Status String Running

集群运行状态,可取值示例:

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

标签

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

<DescribeClusterResponse>
  <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>
        <Tags>
              <Tag>
                    <Value>test-value</Value>
                    <Key>test-key</Key>
              </Tag>
        </Tags>
  </Cluster>
</DescribeClusterResponse>

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",
        "Tags": {
            "Tag": {
                "Value": "test-value",
                "Key": "test-key"
            }
        }
    }
}

错误码

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

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