调用DescribeDBClusterAttribute接口查看PolarDB集群的详细属性。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 否 | DescribeDBClusterAttribute |
系统规定参数,取值为DescribeDBClusterAttribute。 |
DBClusterId | String | 是 | pc-***************** |
集群ID。 说明 您可以通过DescribeDBClusters接口查看账号下所有集群的详细信息,包括集群ID。
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Category | String | Normal |
产品系列,取值范围如下:
说明
|
CreationTime | String | 2020-08-14T05:58:42Z |
集群创建时间。 |
DBClusterDescription | String | test |
集群描述。 |
DBClusterId | String | pc-***************** |
集群ID。 |
DBClusterNetworkType | String | VPC |
集群的网络类型。 |
DBClusterStatus | String | Running |
集群状态,取值范围如下:
|
DBNodes | Array of DBNode |
节点信息详情。 |
|
CreationTime | String | 2020-03-23T21:35:43Z |
节点创建时间。 |
DBNodeClass | String | polar.mysql.x4.large |
节点规格。 |
DBNodeId | String | pi-**************** |
节点ID。 |
DBNodeRole | String | Reader |
节点角色,取值范围如下:
|
DBNodeStatus | String | Running |
节点状态,取值范围如下:
|
FailoverPriority | Integer | 1 |
Failover优先级。每个节点都有一个Failover优先级,决定了当故障切换时,该节点被选举为主节点的概率高低。数值越大,优先级越高,取值范围为1~15。 |
MaxConnections | Integer | 8000 |
最大集群并发连接数。 |
MaxIOPS | Integer | 32000 |
最大I/O请求次数,即IOPS。 |
ZoneId | String | cn-hangzhou-i |
可用区ID。 |
DBType | String | MySQL |
数据库引擎类型。 |
DBVersion | String | 8.0 |
数据库引擎版本。 |
DBVersionStatus | String | Stable |
当前数据库小版本状态,取值范围如下:
说明 关于如何升级数据库小版本,请参见版本升级。
|
DataLevel1BackupChainSize | Long | 74448896 |
一级备份(快照)总大小,单位为Byte。 |
DeletionLock | Integer | 0 |
集群删除的锁定状态,取值范围如下:
|
Engine | String | POLARDB |
集群引擎。 |
ExpireTime | String | 2020-11-14T16:00:00Z |
集群到期时间。 说明 仅付费方式为Prepaid(包年包月)的集群会返回具体参数值,Postpaid(按量付费)集群则返回空值。
|
Expired | String | false |
集群是否到期。 说明 仅付费方式为Prepaid(包年包月)的集群支持返回该参数。
|
IsLatestVersion | Boolean | false |
是否为最新内核版本。 |
LockMode | String | Unlock |
锁定模式,取值范围如下:
|
MaintainTime | String | 18:00Z-19:00Z |
集群的可维护时间段,格式为 |
PayType | String | Prepaid |
付费类型:
|
RegionId | String | cn-hangzhou |
地域ID。 |
RequestId | String | 074467EF-86B9-4C23-ACBF-E9B81A****** |
请求ID。 |
ResourceGroupId | String | rg-*************** |
资源组ID。 |
SQLSize | Long | 0 |
SQL的存储量,单位为Byte。若数值为-1,则表示没有数据。 |
StorageMax | Long | 10995116277760 |
当前集群规格的最大存储容量,单位为Byte。 |
StorageUsed | Long | 3012558848 |
存储空间的使用量,单位为Byte。 |
SubCategory | String | Exclusive |
计算节点的规格类型,取值范围如下:
说明 仅PolarDB MySQL引擎集群版支持返回该参数。
|
Tags | Array of Tag |
标签信息详情。 |
|
Key | String | test |
标签键。 |
Value | String | MySQL |
标签值。 |
VPCId | String | vpc-******************* |
专有网络ID。 |
VSwitchId | String | vsw-********************* |
虚拟交换机ID。 |
ZoneIds | String | cn-hangzhou-i,cn-hangzhou-g |
可用区ID。 |
示例
请求示例
http(s)://polardb.aliyuncs.com/?Action=DescribeDBClusterAttribute
&DBClusterId=pc-*****************
&<公共请求参数>
正常返回示例
XML
格式
<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
格式
{
"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"
}
错误码
访问错误中心查看更多错误码。