Queries the detailed attributes of a PolarDB cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String No DescribeDBClusterAttribute

The operation that you want to perform. Set the value to DescribeDBClusterAttribute.

DBClusterId String Yes pc-*****************

The ID of the cluster.

Note You can call the DescribeDBClusters operation to query the details of all clusters that belong to your account, such as the cluster ID.

Response parameters

Parameter Type Example Description
Category String Normal

The edition of the PolarDB service. Valid values:

  • Normal: Cluster Edition
  • Basic: Single Node
  • Archive: Archive Database
Note
  • You can set this parameter to Single Node for only the clusters of ApsaraDB PolarDB MySQL-compatible edition 5.6, 5.7, and 8.0.
  • You can set this parameter to Archive Database for only the clusters of ApsaraDB PolarDB MySQL-compatible edition 8.0.
CreationTime String 2020-08-14T05:58:42Z

The time when the cluster was created.
DBClusterDescription String test

The description of the cluster.
DBClusterId String pc-*****************

The ID of the cluster.
DBClusterNetworkType String VPC

The network type of the cluster.
DBClusterStatus String Running

The status of the cluster. Valid values:

  • Creating: The cluster is being created.
  • Running: The cluster is running.
  • Deleting: The cluster is being released.
  • Rebooting: The cluster is restarting.
  • DBNodeCreating: The node is being added.
  • DBNodeDeleting: The node is being deleted.
  • ClassChanging: The node specification is being changed.
  • NetAddressCreating: The network connection is being created.
  • NetAddressDeleting: The network connection is being deleted.
  • NetAddressModifying: The network connection is being modified.
  • Deleted: The cluster has been released.
DBNodes Array of DBNode

The details of the node.
CreationTime String 2020-03-23T21:35:43Z

The time when the node was created.
DBNodeClass String polar.mysql.x4.large

The specification of the node.
DBNodeId String pi-****************

The ID of the node.
DBNodeRole String Reader

The role of the node. Valid values:

  • Writer: primary node
  • Reader: read-only node
DBNodeStatus String Running

The status of the node. Valid values:

  • Creating: The node is being created.
  • Running: The node is running.
  • Deleting: The node is being deleted.
  • Rebooting: The node is restarting.
  • DBNodeCreating: The node is being added.
  • DBNodeDeleting: The node is being deleted.
  • ClassChanging: The node specification is being changed.
  • NetAddressCreating: The network connection is being created.
  • NetAddressDeleting: The network connection is being deleted.
  • NetAddressModifying: The network connection is being modified.
  • MinorVersionUpgrading: The minor version is being upgraded.
  • Maintaining: The instance is being maintained.
  • Switching: A failover is in progress.
FailoverPriority Integer 1

The failover priority. Each node has a failover priority. This priority determines the probability at which a node is elected as a primary node if a failover occurs. A larger value indicates a higher priority. Valid values: 1 to 15.

MaxConnections Integer 8000

The maximum number of concurrent connections in the cluster.
MaxIOPS Integer 32000

The maximum number of input/output operations per second (IOPS).
ZoneId String cn-hangzhou-i

The ID of the zone.
DBType String MySQL

The type of the database engine.
DBVersion String 8.0

The version number of the database engine.
DBVersionStatus String Stable

The status of the minor version. Valid values:

  • Stable: The current version is stable.
  • Old: The current version is outdated. We recommend that you upgrade the cluster to the latest version.
  • HighRisk: The current version has critical defects. We recommend that you immediately upgrade the cluster to the latest version.
Note For more information about how to upgrade the minor version, see Upgrade versions.
DataLevel1BackupChainSize Long 74448896

The total physical storage of level-1 backups (snapshots). Unit: bytes.
DeletionLock Integer 0

Indicates whether the cluster is locked and can be deleted. Valid values:

  • 0: The cluster is not locked and can be deleted.
  • 1: The cluster is locked and cannot be deleted.
Engine String POLARDB

The engine of the cluster.
ExpireTime String 2020-11-14T16:00:00Z

The time when the cluster expires.

Note This parameter is returned for only the subscription clusters that use the Prepaid billing method. An empty value is returned for pay-as-you-go clusters that use the Postpaid billing method.
Expired String false

Indicates whether the cluster has expired.

Note This parameter is returned for only subscription clusters whose billing method is set to Prepaid.
IsLatestVersion Boolean false

Indicates whether the kernel is of the latest version.
LockMode String Unlock

The lock mode. Valid values:

  • Unlock: The cluster is not locked.
  • ManualLock: The cluster is manually locked.
  • LockByExpiration: The cluster is automatically locked after the cluster expires.
MaintainTime String 18:00Z-19:00Z

The maintenance window of the cluster. The format is HH:mmZ-HH:mmZ. The time is displayed in UTC. For example, the value 16:00Z-17:00Z indicates that the cluster can be maintained from 00:00 to 01:00 (UTC+08:00).

PayType String Prepaid

The billing method of the instance. Valid values:

  • Postpaid: the pay-as-you-go billing method.
  • Prepaid: the subscription billing method.
RegionId String cn-hangzhou

The ID of the region.
RequestId String 074467EF-86B9-4C23-ACBF-E9B81A******

The ID of the request.
ResourceGroupId String rg-***************

The ID of the resource group.
SQLSize Long 0

The storage of SQL. Unit: bytes. If the value is -1, no data is stored.
StorageMax Long 10995116277760

The maximum storage capacity of the current cluster specification. Unit: bytes.
StorageUsed Long 3012558848

The used storage space. Unit: bytes.
SubCategory String Exclusive

The specification type of the compute node. Valid values:

  • Exclusive: dedicated specifications.
  • General: general-purpose specifications.
Note This parameter is returned for only ApsaraDB PolarDB MySQL-compatible edition clusters of Cluster Edition.
Tags Array of Tag

The details of the tag.
Key String test

The key of the tag.
Value String MySQL

The value of the tag.
VPCId String vpc-*******************

The ID of the VPC.
VSwitchId String vsw-*********************

The ID of the vSwitch.
ZoneIds String cn-hangzhou-i,cn-hangzhou-g

The ID of the zone.

Examples

Sample requests

http(s)://polardb.aliyuncs.com/? Action=DescribeDBClusterAttribute
&DBClusterId=pc-*****************
&<Common request parameters>

Sample success responses

XML format 

<DescribeDBClusterAttributeResponse>
  <DeletionLock>0</DeletionLock>
  <Category>Normal</Category>
  <ResourceGroupId>rg-***************</ResourceGroupId>
  <DataLevel1BackupChainSize>74448896</DataLevel1BackupChainSize>
  <DBClusterId>pc-*****************</DBClusterId>
  <DBClusterNetworkType>VPC</DBClusterNetworkType>
  <DBType>MySQL</DBType>
  <IsLatestVersion>false</IsLatestVersion>
  <DBVersion>5.6</DBVersion>
  <StorageMax>10995116277760</StorageMax>
  <DBNodes>
        <DBNodeStatus>Running</DBNodeStatus>
        <ZoneId>cn-hangzhou-i</ZoneId>
        <MaxConnections>8000</MaxConnections>
        <DBNodeRole>Writer</DBNodeRole>
        <CreationTime>2020-08-14T05:58:42Z</CreationTime>
        <DBNodeId>pi-****************</DBNodeId>
        <FailoverPriority>1</FailoverPriority>
        <DBNodeClass>polar.mysql.x4.large</DBNodeClass>
        <MaxIOPS>32000</MaxIOPS>
  </DBNodes>
  <DBNodes>
        <DBNodeStatus>Running</DBNodeStatus>
        <ZoneId>cn-hangzhou-i</ZoneId>
        <MaxConnections>8000</MaxConnections>
        <DBNodeRole>Reader</DBNodeRole>
        <CreationTime>2020-08-14T05:58:42Z</CreationTime>
        <DBNodeId>pi-****************</DBNodeId>
        <FailoverPriority>1</FailoverPriority>
        <DBNodeClass>polar.mysql.x4.large</DBNodeClass>
        <MaxIOPS>32000</MaxIOPS>
  </DBNodes>
  <ZoneIds>cn-hangzhou-i,cn-hangzhou-g</ZoneIds>
  <MaintainTime>18:00Z-19:00Z</MaintainTime>
  <Engine>POLARDB</Engine>
  <Tags>
        <Value>MySQL</Value>
        <Key>test</Key>
  </Tags>
  <RequestId>074467EF-86B9-4C23-ACBF-E9B81AA******</RequestId>
  <VPCId>vpc-*******************</VPCId>
  <DBClusterStatus>Running</DBClusterStatus>
  <VSwitchId>vsw-*********************</VSwitchId>
  <DBClusterDescription>test</DBClusterDescription>
  <Expired>false</Expired>
  <PayType>Prepaid</PayType>
  <LockMode>Unlock</LockMode>
  <StorageUsed>3012558848</StorageUsed>
  <DBVersionStatus>Stable</DBVersionStatus>
  <SubCategory>Exclusive</SubCategory>
  <CreationTime>2020-08-14T05:58:42Z</CreationTime>
  <RegionId>cn-hangzhou</RegionId>
  <SQLSize>0</SQLSize>
  <ExpireTime>2020-11-14T16:00:00Z</ExpireTime>
</DescribeDBClusterAttributeResponse>

JSON format 

{
        "DeletionLock": 0,
        "Category": "Normal",
        "ResourceGroupId": "rg-***************",
        "DataLevel1BackupChainSize": 74448896,
        "DBClusterId": "pc-*****************",
        "DBClusterNetworkType": "VPC",
        "DBType": "MySQL",
        "IsLatestVersion": false,
        "DBVersion": 5.6,
        "StorageMax": 10995116277760,
        "DBNodes": [
            {
                "DBNodeStatus": "Running",
                "ZoneId": "cn-hangzhou-i",
                "MaxConnections": 8000,
                "DBNodeRole": "Writer",
                "CreationTime": "2020-08-14T05:58:42Z",
                "DBNodeId": "pi-****************",
                "FailoverPriority": 1,
                "DBNodeClass": "polar.mysql.x4.large",
                "MaxIOPS": 32000
            },
            {
                "DBNodeStatus": "Running",
                "ZoneId": "cn-hangzhou-i",
                "MaxConnections": 8000,
                "DBNodeRole": "Reader",
                "CreationTime": "2020-08-14T05:58:42Z",
                "DBNodeId": "pi-****************",
                "FailoverPriority": 1,
                "DBNodeClass": "polar.mysql.x4.large",
                "MaxIOPS": 32000
            }
        ],
        "ZoneIds": "cn-hangzhou-i,cn-hangzhou-g",
        "MaintainTime": "18:00Z-19:00Z",
        "Engine": "POLARDB",
        "Tags": {
            "Value": "MySQL",
            "Key": "test"
        },
        "RequestId": "074467EF-86B9-4C23-ACBF-E9B81AA******",
        "VPCId": "vpc-*******************",
        "DBClusterStatus": "Running",
        "VSwitchId": "vsw-*********************",
        "DBClusterDescription": "test",
        "Expired": false,
        "PayType": "Prepaid",
        "LockMode": "Unlock",
        "StorageUsed": 3012558848,
        "DBVersionStatus": "Stable",
        "SubCategory": "Exclusive",
        "CreationTime": "2020-08-14T05:58:42Z",
        "RegionId": "cn-hangzhou",
        "SQLSize": 0,
        "ExpireTime": "2020-11-14T16:00:00Z"
    }

Error codes

For a list of error codes, visit the API Error Center.