DescribeDBClusterAttribute
该接口用于查看指定POLARDB集群的详细属性。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
DBClusterId | String | 是 | pc-xxxxxxxxxxxxxxx |
集群ID。 |
AccessKeyId | String | 否 | key-test |
阿里云颁发给用户的访问服务所用的密钥ID。 |
Action | String | 否 | DescribeDBClusterAttribute |
系统规定参数,取值:DescribeDBClusterAttribute。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
CreationTime | String | 2019-04-26T06:01:28Z |
创建时间。 |
DBClusterDescription | String | test |
集群描述。 |
DBClusterId | String | pc-xxxxxxxxxxxxxx |
集群ID。 |
DBClusterNetworkType | String | VPC |
集群的网络类型。 |
DBClusterStatus | String | Running |
集群状态:
|
DBNodes | Array |
DBNode组成的集合。 |
|
CreationTime | String | 2019-04-26T22:01:28Z |
创建时间。 |
DBNodeClass | String | polar.mysql.x2.medium |
节点规格。 |
DBNodeId | String | pi-xxxxxxxxxxxxxx |
节点ID。 |
DBNodeRole | String | Writer |
节点角色:
|
DBNodeStatus | String | Running |
节点状态。 |
FailoverPriority | Integer | 1 |
Failover优先级。 |
MaxConnections | Integer | 1200 |
最大集群并发连接数。 |
MaxIOPS | Integer | 8000 |
最大I/O请求次数,即IOPS。 |
ZoneId | String | cn-qingdao-c |
可用区ID。 |
DBType | String | MySQL |
数据库引擎类型。 |
DBVersion | String | 5.6 |
数据库引擎版本。 |
DeletionLock | Integer | 0 |
集群删除的锁定状态:
|
Engine | String | POLARDB |
集群引擎。 |
ExpireTime | String | 2019-09-14T16:00:00Z |
到期时间。 说明 按量付费集群无到期时间。
|
Expired | String | false |
是否过期。 |
IsLatestVersion | Boolean | false |
是否为最新内核版本。 |
LockMode | String | Unlock |
锁定模式:
|
MaintainTime | String | 18:00Z-19:00Z |
集群的可维护时间段。格式: 示例: |
PayType | String | Postpaid |
付费类型:
|
RegionId | String | cn-hangzhou |
地域ID。 |
RequestId | String | 4E148395-950A-46F8-BFF8-274A64CD793B |
请求ID。 |
SQLSize | Long | 0 |
SQL的存储量,单位:Byte。-1表示没有数据。 |
StorageMax | Long | 5497558138880 |
当前集群规格的最大存储容量,单位:Byte。 |
StorageUsed | Long | 3133145088 |
存储空间的使用量,单位:Byte。 |
Tags | Array |
标签组成的集合。 |
|
Key | String | test1 |
标签键。 |
Value | String | 1111 |
标签值。 |
VPCId | String | vpc-xxxxxxxxxxxxxx |
专有网络ID。 |
VSwitchId | String | vsw-xxxxxxxxxxxxxx |
虚拟交换机ID。 |
ZoneIds | String | cn-hangzhou-i,cn-hangzhou-g |
数据分布的可用区。 |
示例
请求示例
http(s)://[Endpoint]/?Action=DescribeDBClusterAttribute
&DBClusterId=pc-xxxxxxxxxxxxxxx
&<公共请求参数>
正常返回示例
XML
格式
<DBVersion>5.6</DBVersion>
<LockMode>Unlock</LockMode>
<DBClusterDescription>test</DBClusterDescription>
<DBClusterNetworkType>VPC</DBClusterNetworkType>
<DBClusterId>pc-xxxxxxxxxxxxxx</DBClusterId>
<VSwitchId>vsw-xxxxxxxxxxxxxx</VSwitchId>
<Engine>POLARDB</Engine>
<DBClusterStatus>Running</DBClusterStatus>
<CreationTime>2019-04-26T06:01:28Z</CreationTime>
<MaintainTime>18:00Z-19:00Z</MaintainTime>
<VPCId>vpc-xxxxxxxxxxxxxx</VPCId>
<ExpireTime/>
<Expired>false</Expired>
<RequestId>4E148395-950A-46F8-BFF8-274A64CD793B</RequestId>
<RegionId>cn-hangzhou</RegionId>
<DBType>MySQL</DBType>
<DBNodes>
<CreationTime>2019-04-26T22:01:28Z</CreationTime>
<MaxIOPS>8000</MaxIOPS>
<DBNodeRole>Writer</DBNodeRole>
<MaxConnections>1200</MaxConnections>
<DBNodeClass>polar.mysql.x2.medium</DBNodeClass>
<DBNodeStatus>Running</DBNodeStatus>
<ZoneIds>cn-hangzhou-i,cn-hangzhou-g</ZoneIds>
<DBNodeId>pi-xxxxxxxxxxxxxx</DBNodeId>
</DBNodes>
<DBNodes>
<CreationTime>2019-04-26T22:01:28Z</CreationTime>
<MaxIOPS>8000</MaxIOPS>
<DBNodeRole>Reader</DBNodeRole>
<MaxConnections>1200</MaxConnections>
<DBNodeClass>polar.mysql.x2.medium</DBNodeClass>
<DBNodeStatus>Running</DBNodeStatus>
<ZoneIds>cn-hangzhou-i,cn-hangzhou-g</ZoneIds>
<DBNodeId>pi-xxxxxxxxxxxxxx</DBNodeId>
</DBNodes>
<SQLSize>0</SQLSize>
<PayType>Postpaid</PayType>
JSON
格式
{
"DBVersion":"5.6",
"LockMode":"Unlock",
"DBClusterDescription":"test",
"DBClusterNetworkType":"VPC",
"DBClusterId":"pc-xxxxxxxxxxxxxx",
"VSwitchId":"vsw-xxxxxxxxxxxxxx",
"Engine":"POLARDB",
"DBClusterStatus":"Running",
"CreationTime":"2019-04-26T06:01:28Z",
"MaintainTime":"18:00Z-19:00Z",
"Tags":[],
"VPCId":"vpc-xxxxxxxxxxxxxx",
"ExpireTime":"",
"RegionId":"cn-hangzhou",
"RequestId":"4E148395-950A-46F8-BFF8-274A64CD793B",
"Expired":false,
"DBType":"MySQL",
"SQLSize":0,
"DBNodes":[
{
"CreationTime":"2019-04-26T22:01:28Z",
"MaxIOPS":8000,
"DBNodeRole":"Writer",
"MaxConnections":1200,
"DBNodeClass":"polar.mysql.x2.medium",
"DBNodeStatus":"Running",
"ZoneIds":"cn-hangzhou-i,cn-hangzhou-g",
"DBNodeId":"pi-xxxxxxxxxxxxxx"
},
{
"CreationTime":"2019-04-26T22:01:28Z",
"MaxIOPS":8000,
"DBNodeRole":"Reader",
"MaxConnections":1200,
"DBNodeClass":"polar.mysql.x2.medium",
"DBNodeStatus":"Running",
"ZoneIds":"cn-hangzhou-i,cn-hangzhou-g",
"DBNodeId":"pi-xxxxxxxxxxxxxx"
}
],
"PayType":"Postpaid"
}
错误码
访问错误中心查看更多错误码。
版权声明
本文仅代表作者观点,不代表本站立场。
本文系作者授权发表,未经许可,不得转载。
评论