You can call this operation to query the detailed attributes of a specified cluster.

Request parameters

Parameter Type Required Description
Action String Yes The operation that you want to perform. Set the value to DescribeDBClusterAttribute.
DBClusterId String Yes The ID of the cluster.

Response parameters

Parameter Type Description
<Common response parameters> - For more information, see Common parameters.
DBCluster DBCluster The ID of the cluster.
EncryptionKey String The ID of the key that is managed by Key Management Service (KMS). This parameter is empty if no encryption is performed.
EncryptionType String The type of the encryption. The valid value is CloudDisk, which indicates that only disk encryption is supported. This parameter is empty if no encryption is performed.

DBCluster

Parameter Type Description
RegionId String The region ID of the cluster.
ZoneId String The zone ID of the cluster.
DBClusterId String The ID of the cluster.
DBClusterDescription String The description of the cluster.
Category String

The edition of the cluster. Valid values:

  • Basic
  • HighAvailability
LockMode String

The lock mode of the cluster. Valid values:

  • Unlock: The cluster is not locked.
  • ManualLock: The cluster is manually locked.
  • LockByExpiration: The cluster is automatically locked upon expiration.
  • LockByRestoration: The cluster is automatically locked before a rollback.
  • LockByDiskQuota: The cluster is automatically locked when its disk space is full.
LockReason String The reason why the cluster is locked.
PayType String The billing method of the cluster. Valid values:
  • Postpaid: pay-as-you-go
  • Prepaid: subscription
EngineVersion String The engine version.
DBClusterStatus String The status of the cluster. For more information, see Cluster status table.
DBNodeStorage Long The storage space of the node. Unit: GB.
DBNodeClass String The node type. Example: C8
DBNodeCount Long The number of nodes.
StorageType String

The storage type.

  • CloudSSD: standard SSD
  • CloudEfficiency: ultra disk
CreateTime String

The time when the cluster was created. The time follows the ISO 8601 standard in the yyyy-MM-dd'T'HH:mm:ss'Z' format.

Example: 2011-05-30T12:11:4Z.
ExpireTime String

The time when the cluster expires. The time follows the ISO 8601 standard in the yyyy-MM-dd'T'HH:mm:ss'Z' format.

Example: 2011-05-30T12:11:4Z.

Note Pay-as-you-go clusters never expire.
MaintainTime String

The maintenance window of the cluster.

The format is HH:mmZ-HH:mmZ.

Example: 00:00Z-01:00Z. This value indicates that the cluster can be performed from 00:00 to 01:00 (UTC+8).

VpcId String The ID of the virtual private cloud (VPC).
VSwitchId String The ID of the vSwitch.
VpcCloudInstanceId String The ID that is assigned by the VPC to the cluster.
CommodityCode String The commodity code.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeDBClusterAttribute
&DBClusterId=cc-xxxxxxxxxxxxxxx
&<Common request parameters>

Sample success responses

XML format

<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 format

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