该接口用于查看指定实例的详细属性。

请求参数

名称 类型 是否必须 描述
Action String 系统规定参数,取值:DescribeDBClusterAttribute。
DBClusterId String 实例ID。

返回参数

名称 类型 描述
<公共返回参数> - 详见公共参数
DBCluster DBCluster 实例

DBCluster

名称 类型 描述
RegionId String 地域ID。
ZoneId String 可用区
DBClusterId String 实例ID。
DBClusterDescription String 实例描述。
Category String

实例系列,取值:

  • Basic:基础版;
  • HighAvailability:高可用版
LockMode String

实例锁定模式:

  • Unlock:正常;
  • ManualLock:手动触发锁定;
  • LockByExpiration:实例过期自动锁定;
  • LockByRestoration:实例回滚前的自动锁定;
  • LockByDiskQuota:实例空间满自动锁定。
LockReason String 锁定原因
PayType String 付费类型:
  • Postpaid:按量付费;
  • Prepaid:预付费(包年包月)。
EngineVersion String 引擎版本
DBClusterStatus String 实例状态。集群状态表
DBNodeStorage Long 存储空间,单位:GB
DBNodeClass String 节点类型。 C8
DBNodeCount Long 节点组个数
StorageType String

存储类型

  • CloudSSD:SSD云盘
  • CloudEfficiency:高效云盘
CreateTime String

创建时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z'

,如2011-05-30T12:11:4Z。
ExpireTime String

到期时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z'

,如2011-05-30T12:11:4Z。

说明 按量付费实例无到期时间。
MaintainTime String

实例的可维护时间:

格式:HH:mmZ- HH:mmZ

示例:00:00Z-01:00Z,表示0点到1点可进行例行维护。

VpcId String VPC ID
VSwitchId String 交换机ID。
VpcCloudInstanceId String VPC资源ID
CommodityCode String 售卖商品CODE

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeDBClusterAttribute
&DBClusterId=cc-xxxxxxxxxxxxxxx
&<公共请求参数>

正常返回示例

XML 格式

<DBCluster>
  <Category>HighAvailability</Category>
  <CreateTime>2019-09-11T11:33:11Z</CreateTime>
  <DBClusterDescription>cc-bp108z124a8o74208</DBClusterDescription>
  <DBClusterId>cc-bp108z124a8o74208</DBClusterId>
  <DBClusterNetworkType>vpc</DBClusterNetworkType>
  <DBClusterStatus>Running</DBClusterStatus>
  <DBNodeClass>C8</DBNodeClass>
  <DBNodeCount>2</DBNodeCount>
  <DBNodeStorage>100</DBNodeStorage>
  <Engine>ClickHouse</Engine>
  <EngineVersion>19.15.2.2</EngineVersion>
  <ExpireTime>2019-11-11T16:00:00Z</ExpireTime>
  <IsExpired>false</IsExpired>
  <LockMode>Unlock</LockMode>
  <LockReason></LockReason>
  <MaintainTime>18:00Z-19:00Z</MaintainTime>
  <PayType>Prepaid</PayType>
  <RegionId>cn-hangzhou</RegionId>
  <Tags>
    <Tag></Tag>
  </Tags>
  <VpcCloudInstanceId>cc-bp108z124a8o74208-controller</VpcCloudInstanceId>
  <VpcId>vpc-bp10tr8k9qasioatym6zo</VpcId>
  <VSwitchId>vsw-bp1n874li1t5y57wi3njj</VSwitchId>
  <ZoneId>cn-hangzhou-h</ZoneId>
</DBCluster>
<RequestId>05321590-BB65-4720-8CB6-8218E041CDD0</RequestId>

JSON 格式

{
  "DBCluster": {
    "DBNodeCount": 2,
    "ZoneId": "cn-hangzhou-h",
    "DBClusterId": "cc-bp108z124a8o74208",
    "VSwitchId": "vsw-bp1n874li1t5y57wi3njj",
    "Engine": "ClickHouse",
    "EngineVersion": "19.15.2.2",
    "DBClusterStatus": "Running",
    "MaintainTime": "18:00Z-19:00Z",
    "VpcId": "vpc-bp10tr8k9qasioatym6zo",
    "PayType": "Prepaid",
    "LockMode": "Unlock",
    "DBClusterDescription": "cc-bp108z124a8o74208",
    "DBClusterNetworkType": "vpc",
    "VpcCloudInstanceId": "cc-bp108z124a8o74208-controller",
    "CreateTime": "2019-09-11T11:33:11Z",
    "Tags": {
      "Tag": []
    },
    "Category": "HighAvailability",
    "ExpireTime": "2019-11-11T16:00:00Z",
    "DBNodeClass": "C8",
    "RegionId": "cn-hangzhou",
    "IsExpired": false,
    "LockReason": "",
    "DBNodeStorage": 100
  },
  "RequestId": "05321590-BB65-4720-8CB6-8218E041CDD0"
}