Queries the details of an Apsara 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.

Response parameters

Parameter Type Example Description
CreationTime String 2020-03-23T05:35:43Z

The time when the cluster was created.

DBClusterDescription String GDN 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 deleted.
  • Rebooting: The cluster is restarting.
  • DBNodeCreating: The node is being added to the cluster.
  • DBNodeDeleting: The node is being removed from the cluster.
  • 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 is deleted.
DBNodes Array

The list of the nodes that are included in the cluster.

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 removed from the cluster.
  • Rebooting: The node is restarting.
  • DBNodeCreating: The node is being added to the cluster.
  • DBNodeDeleting: The node is being removed from the cluster.
  • 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 cluster is being maintained.
  • Switching: A failover is occurring.
FailoverPriority Integer 1

The priority for the node to function as a primary node, if a failover occurs. Each node has a failover priority. If a failover occurs, a node may function as a primary node. This priority determines the probability at which a node functions as a primary node. A higher value indicates a higher priority. Valid values: 1 to 15.

MaxConnections Integer 1200

The maximum number of concurrent connections that are supported by the cluster.

MaxIOPS Integer 8000

The maximum number of input/output operations per second (IOPS).

ZoneId String cn-qingdao-c

The ID of the zone.

DBType String MySQL

The type of the database engine.

DBVersion String 8.0

The version of the database engine.

DataLevel1BackupChainSize Long 1389363200

The total size of the level-1 snapshot backups. Unit: bytes.

DeletionLock Integer 0

Indicates whether the cluster is locked and whether the cluster 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-06-14T16:00:00Z

The expiration time of the cluster.

Note Pay-as-you-go clusters do not expire.
Expired String false

Indicates whether the cluster expired.

IsLatestVersion Boolean false

Indicates whether the kernel version was the latest version.

LockMode String Unlock

The lock status of the cluster. 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 16:00Z-17:00Z

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

PayType String Postpaid

The billing method. Valid values:

  • Postpaid: pay-as-you-go
  • Prepaid: subscription
RegionId String cn-hangzhou

The ID of the region.

RequestId String 6A8952B9-6ADD-4AF6-A96F-6C01B6******

The ID of the request.

ResourceGroupId String rg-***************

The ID of the resource group.

SQLSize Long 0

The storage space that is consumed by SQL data. Unit: bytes. The value -1 indicates that no data is stored.

StorageMax Long 10995116277760

The maximum storage capacity that is supported by the current cluster type. Unit: bytes.

StorageUsed Long 4864344064

The storage space that is consumed by the cluster. Unit: bytes.

Tags Array

The set of tags.

Key String test1

The key of the tag.

Value String 1111

The value of the tag.

VPCId String vpc-*******************

The ID of the virtual private cloud (VPC).

VSwitchId String vsw-*********************

The ID of the VSwitch.

ZoneIds String cn-hangzhou-i

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

<DeletionLock>0</DeletionLock>
<ResourceGroupId>rg-***************</ResourceGroupId>
<DataLevel1BackupChainSize>1389363200</DataLevel1BackupChainSize>
<DBClusterId>pc-*****************</DBClusterId>
<DBClusterNetworkType>VPC</DBClusterNetworkType>
<DBType>MySQL</DBType>
<IsLatestVersion>false</IsLatestVersion>
<DBVersion>8.0</DBVersion>
<StorageMax>10995116277760</StorageMax>
<DBNodes>
    <DBNodeStatus>Running</DBNodeStatus>
    <ZoneId>cn-hangzhou-i</ZoneId>
    <MaxConnections>8000</MaxConnections>
    <DBNodeRole>Reader</DBNodeRole>
    <CreationTime>2020-03-23T21:35:43Z</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>Writer</DBNodeRole>
    <CreationTime>2020-03-23T21:35:43Z</CreationTime>
    <DBNodeId>pi-****************</DBNodeId>
    <FailoverPriority>0</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-05-08T18:28:22Z</CreationTime>
    <DBNodeId>pi-****************</DBNodeId>
    <FailoverPriority>1</FailoverPriority>
    <DBNodeClass>polar.mysql.x4.large</DBNodeClass>
    <MaxIOPS>32000</MaxIOPS>
</DBNodes>
<ZoneIds>cn-hangzhou-i,cn-hangzhou-i</ZoneIds>
<MaintainTime>16:00Z-17:00Z</MaintainTime>
<Engine>POLARDB</Engine>
<RequestId>6A8952B9-6ADD-4AF6-A96F-6C01B6******</RequestId>
<VPCId>vpc-*******************</VPCId>
<DBClusterStatus>Running</DBClusterStatus>
<VSwitchId>vsw-*********************</VSwitchId>
<DBClusterDescription>GDN test</DBClusterDescription>
<Expired>false</Expired>
<PayType>Postpaid</PayType>
<LockMode>Unlock</LockMode>
<StorageUsed>4864344064</StorageUsed>
<CreationTime>2020-03-23T05:35:43Z</CreationTime>
<RegionId>cn-hangzhou</RegionId>
<SQLSize>0</SQLSize>
<ExpireTime/>

JSON format

{
    "DeletionLock": 0,
    "ResourceGroupId": "rg-***************",
    "DataLevel1BackupChainSize": 1389363200,
    "DBClusterId": "pc-*****************",
    "DBClusterNetworkType": "VPC",
    "DBType": "MySQL",
    "IsLatestVersion": false,
    "DBVersion": "8.0",
    "StorageMax": 10995116277760,
    "DBNodes": [
        {
            "DBNodeStatus": "Running",
            "ZoneId": "cn-hangzhou-i",
            "MaxConnections": 8000,
            "DBNodeRole": "Reader",
            "CreationTime": "2020-03-23T21:35:43Z",
            "DBNodeId": "pi-****************",
            "FailoverPriority": 1,
            "DBNodeClass": "polar.mysql.x4.large",
            "MaxIOPS": 32000
        },
        {
            "DBNodeStatus": "Running",
            "ZoneId": "cn-hangzhou-i",
            "MaxConnections": 8000,
            "DBNodeRole": "Writer",
            "CreationTime": "2020-03-23T21:35:43Z",
            "DBNodeId": "pi-****************",
            "FailoverPriority": 0,
            "DBNodeClass": "polar.mysql.x4.large",
            "MaxIOPS": 32000
        },
        {
            "DBNodeStatus": "Running",
            "ZoneId": "cn-hangzhou-i",
            "MaxConnections": 8000,
            "DBNodeRole": "Reader",
            "CreationTime": "2020-05-08T18:28:22Z",
            "DBNodeId": "pi-****************",
            "FailoverPriority": 1,
            "DBNodeClass": "polar.mysql.x4.large",
            "MaxIOPS": 32000
        }
    ],
    "ZoneIds": "cn-hangzhou-i,cn-hangzhou-i",
    "MaintainTime": "16:00Z-17:00Z",
    "Engine": "POLARDB",
    "Tags": [],
    "RequestId": "6A8952B9-6ADD-4AF6-A96F-6C01B6******",
    "VPCId": "vpc-*******************",
    "DBClusterStatus": "Running",
    "VSwitchId": "vsw-*********************",
    "DBClusterDescription": "GDN test",
    "Expired": false,
    "PayType": "Postpaid",
    "LockMode": "Unlock",
    "StorageUsed": 4864344064,
    "CreationTime": "2020-03-23T05:35:43Z",
    "RegionId": "cn-hangzhou",
    "SQLSize": 0,
    "ExpireTime": ""
}

Error codes

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