DescribeDBClusters
调用DescribeDBClusters接口查看集群列表或被RAM授权的集群列表。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeDBClusters | 系统规定参数,取值: DescribeDBClusters。 |
RegionId | String | 是 | cn-hangzhou | 地域ID。 |
DBClusterIds | String | 否 | am-bp1xxxxxxxx47 | 实例ID。 如果有多个实例ID,以英文逗号(,)分隔。 |
DBClusterDescription | String | 否 | 测试数据库 | 实例描述,支持模糊查询。 |
DBClusterStatus | String | 否 | Running | 实例状态,例如实例创建中、锁定中等,详情请参见实例状态表。 |
PageSize | Integer | 否 | 30 | 每页记录数,取值:
|
PageNumber | Integer | 否 | 1 | 页码,取值:大于0且不超过Integer的最大值。 默认值:1。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 1AD222E9-E606-4A42-BF6D-8A4442913CEF | 请求ID。 |
PageNumber | Integer | 1 | 页码。 |
TotalCount | Integer | 100 | 总记录数。 |
PageSize | Integer | 2 | 总页数。 |
Items | List<DBCluster> | 由实例信息组成的数组。 |
DBCluster
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
DBClusterId | String | am-bpxxxxxxxx47 | 数据库实例ID。 |
DBClusterDescription | String | 测试数据库 | 实例描述。 |
PayType | String | Postpaid | 实例的付费类型,取值
|
RegionId | String | cn-hangzhou | 地域ID。 |
ZoneId | String | cn-hangzhou-a | 可用区ID。 |
CreateTime | String | 2019-03-20T02:18:02Z | 创建时间。 |
ExpireTime | String | 2020-03-20T02:18:02Z | 到期时间。 说明:按量付费集群无到期时间。 |
DBClusterStatus | String | Running | 实例状态,详情请参见实例状态表。 |
DBNodeClass | String | C8 | 节点类型。 |
DBNodeCount | Integer | 128 | 节点组个数。 |
DBVersion | String | 3.0 | 集群版本,目前只有3.0。 |
DBClusterType | String | Common | 实例类型。取值:Common,主实例。 |
CommodityCode | String | AnalyticDB for MySQL CODE。 |
示例
请求示例
http(s)://[Endpoint]/?Action=DescribeDBClusters
&RegionId=cn-hangzhou
&<公共请求参数>
正常返回示例
XML
格式
<Items>
<DBCluster>
<DBVersion>3.0</DBVersion>
<LockMode>Unlock</LockMode>
<DBClusterDescription>am-bp*********</DBClusterDescription>
<DBNodeCount>2</DBNodeCount>
<DBClusterId>am-bp*********/DBClusterId>
<DBClusterStatus>Running</DBClusterStatus>
<Tags></Tags>
<ExpireTime>2019-11-11T16:00:00Z</ExpireTime>
<RegionId>cn-hangzhou</RegionId>
<Expired>false</Expired>
<CreateTime>2019-09-11T11:33:11Z</CreateTime>
<DBNodeClass>C8</DBNodeClass>
<DBClusterType>Common</DBClusterType>
<LockReason></LockReason>
<PayType>Prepaid</PayType>
<DBNodeStorage>100</DBNodeStorage>
</DBCluster>
</Items>
<PageNumber>1</PageNumber>
<TotalCount>1</TotalCount>
<PageSize>30</PageSize>
<RequestId>F5178C10-1407-4987-9133-DE4DC9119F75</RequestId>
JSON
格式
{
"Items": {
"DBCluster": [
{
"DBVersion": "3.0",
"LockMode": "Unlock",
"DBClusterDescription": "am-bp*********",
"DBNodeCount": 2,
"DBClusterId": "am-bp*********",
"DBClusterStatus": "Running",
"Tags": {
"Tag": []
},
"ExpireTime": "2019-11-11T16:00:00Z",
"RegionId": "cn-hangzhou",
"Expired": false,
"CreateTime": "2019-09-11T11:33:11Z",
"DBNodeClass": "C8",
"DBClusterType": "Common",
"LockReason": "",
"PayType": "Prepaid",
"DBNodeStorage": 100
}
]
},
"PageNumber": 1,
"TotalCount": 1,
"PageSize": 30,
"RequestId": "F5178C10-1407-4987-9133-DE4DC9119F75"
}
版权声明
本文仅代表作者观点,不代表本站立场。
本文系作者授权发表,未经许可,不得转载。
评论