DescribeDBClusterAttribute - API Reference| Alibaba Cloud Documentation Center

Queries details about an AnalyticDB for MySQL cluster.

Request parameters

Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeDBClusterAttribute	The operation that you want to perform. Set the value to DescribeDBClusterAttribute.
DBClusterId	String	Yes	rm-uf6wjk5xxxxxxxxxx	The ID of the cluster whose details are to be queried.

Response parameters

Parameter	Type	Description
<Common response parameters>	String
Items	List<DBCluster>	The details about the cluster.

DBCluster

Parameter	Type	Example	Description
RegionId	String	cn-hangzhou	The ID of the region where the cluster resides.
ZoneId	String	cn-hangzhou-a	The ID of the zone where the cluster is available.
DBClusterId	String	rm-uf6wjk5xxxxxxxxxx	The ID of the cluster.
DBClusterType	String	Primary	The type of the cluster. The value Primary indicates a primary cluster.
DBClusterDescription	String	Test database	The description of the cluster.
Category	String	Basic	The edition of the cluster. The value Basic indicates the basic edition.
LockMode	String	Unlock	The lock mode of the cluster. Valid values: Unlock: The cluster was unlocked. ManualLock: The cluster was manually locked. LockByExpiration: The cluster was automatically locked after it expired. LockByRestoration: The cluster was automatically locked before a rollback. LockByDiskQuota: The cluster was automatically locked when the disk space was full.
LockReason	String	instance_expired	The reason why the cluster was locked.
PayType	String	Postpaid	The billing method of the cluster. Valid values: Postpaid: pay-as-you-go Prepaid: subscription
DBVersion	String	3.0	The database version of the cluster. Currently, only version 3.0 is available.
DBClusterStatus	String	Running	The status of the cluster. For more information, see Cluster status.
DBNodeStorage	Long	100	The storage capacity of the cluster. Unit: GB
DBNodeClass	String	C8	The node type of the cluster, for example, C8.
DBNodeCount	Long	8	The number of nodes in the cluster.
CreationTime	String	2011-05-30T12:11:04Z	The time when the cluster was created. The format is yyyy-MM-dd’T’HH:mm:ss’Z’. Example: 2011-05-30T12:11:4Z
ExpireTime	String	2019-03-27T16:00:00Z	The time when the cluster expires. The format is yyyy-MM-dd’T’HH:mm:ss’Z’. Example: 2011-05-30T12:11:4Z Note: Pay-as-you-go clusters never expire.
MaintainTime	String	00:00Z-02:00Z	The maintenance window of the cluster. The format is HH:mmZ-HH:mmZ. For example, 00:00Z-01:00Z indicates that routine maintenance can be performed from 00:00 to 01:00.
VPCId	String	vpc-xxxxxxxxx	The VPC ID of the cluster.
VSwitchId	String	vsw-xxxxxx	The VSwitch ID of the cluster.
VPCCloudInstanceId	String	vpc-23rsxdfxxxxxxx	The ID of the VPC resource used by the cluster.
CommodityCode	String		The product code of the cluster.

Examples

Sample requests

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

Sample success responses

XML format

<Items>
  <DBCluster>
      <Category>Basic</Category>
      <CreationTime>2019-09-11T11:33:11Z</CreationTime>
      <DBClusterDescription>am-bp*******</DBClusterDescription>
      <DBClusterId>am-bp*********</DBClusterId>
      <DBClusterNetworkType>vpc</DBClusterNetworkType>
      <DBClusterStatus>Running</DBClusterStatus>
      <DBClusterType>Common</DBClusterType>
      <DBNodeClass>C8</DBNodeClass>
      <DBNodeCount>2</DBNodeCount>
      <DBNodeStorage>100</DBNodeStorage>
      <DBVersion>3.0</DBVersion>
      <Engine>AnalyticDB</Engine>
      <ExpireTime>2019-11-11T16:00:00Z</ExpireTime>
      <Expired>false</Expired>
      <LockMode>Unlock</LockMode>
      <LockReason></LockReason>
      <MaintainTime>18:00Z-19:00Z</MaintainTime>
      <PayType>Prepaid</PayType>
      <RegionId>cn-hangzhou</RegionId>
      <Tags>
        <Tag></Tag>
      </Tags>
      <VPCCloudInstanceId>am-bp*********-controller</VPCCloudInstanceId>
      <VPCId>vpc-bp************</VPCId>
      <VSwitchId>vsw-bp*******</VSwitchId>
      <ZoneId>cn-hangzhou-h</ZoneId>
  </DBCluster>
</Items>
<RequestId>05321590-BB65-4720-8CB6-8218E041CDD0</RequestId>

JSON format

{
  "Items": {
    "DBCluster": [
      {
        "DBNodeCount": 2,
        "ZoneId": "cn-hangzhou-h",
        "DBClusterId": "am-bp*******",
        "VSwitchId": "vsw-bp***********",
        "Engine": "AnalyticDB",
        "DBClusterStatus": "Running",
        "MaintainTime": "18:00Z-19:00Z",
        "VPCId": "vpc-bp************",
        "DBClusterType": "Common",
        "PayType": "Prepaid",
        "DBVersion": "3.0",
        "LockMode": "Unlock",
        "DBClusterDescription": "am-bp***********",
        "DBClusterNetworkType": "vpc",
        "VPCCloudInstanceId": "am-bp*********-controller",
        "CreationTime": "2019-09-11T11:33:11Z",
        "Tags": {
          "Tag": []
        },
        "Category": "Basic",
        "ExpireTime": "2019-11-11T16:00:00Z",
        "DBNodeClass": "C8",
        "RegionId": "cn-hangzhou",
        "Expired": false,
        "LockReason": "",
        "DBNodeStorage": 100
      }
    ]
  },
  "RequestId": "05321590-BB65-4720-8CB6-8218E041CDD0"
}