› 推特 ›阿里云技术文档›正文

DescribeDBClusters_集群管理_API参考_分析型数据库MySQL版

admin 阿里云技术文档 2020-02-11 189 0
阿里云服务器优惠

DescribeDBClusters

调用DescribeDBClusters接口查看集群列表或被RAM授权的集群列表。

请求参数

名称类型是否必选示例值描述
ActionString是DescribeDBClusters系统规定参数，取值：

DescribeDBClusters。

RegionIdString是cn-hangzhou地域ID。
DBClusterIdsString否am-bp1xxxxxxxx47实例ID。

如果有多个实例ID，以英文逗号（,）分隔。

DBClusterDescriptionString否测试数据库实例描述，支持模糊查询。
DBClusterStatusString否Running实例状态，例如实例创建中、锁定中等，详情请参见实例状态表。
PageSizeInteger否30每页记录数，取值：
  • 30；
  • 50；
  • 100
默认值：30。
PageNumberInteger否1页码，取值：大于0且不超过Integer的最大值。

默认值：1。

返回数据

名称类型示例值描述
RequestIdString1AD222E9-E606-4A42-BF6D-8A4442913CEF请求ID。
PageNumberInteger1页码。
TotalCountInteger100总记录数。
PageSizeInteger2总页数。
ItemsList<DBCluster>由实例信息组成的数组。

DBCluster

参数类型示例值描述
DBClusterIdStringam-bpxxxxxxxx47数据库实例ID。
DBClusterDescriptionString测试数据库实例描述。
PayTypeStringPostpaid实例的付费类型，取值
  • Postpaid：按量付费；
  • Prepaid：预付费（包年包月）。
RegionIdStringcn-hangzhou地域ID。
ZoneIdStringcn-hangzhou-a可用区ID。
CreateTimeString2019-03-20T02:18:02Z创建时间。
ExpireTimeString2020-03-20T02:18:02Z到期时间。

说明：按量付费集群无到期时间。

DBClusterStatusStringRunning实例状态，详情请参见实例状态表。
DBNodeClassStringC8节点类型。
DBNodeCountInteger128节点组个数。
DBVersionString3.0集群版本，目前只有3.0。
DBClusterTypeStringCommon实例类型。取值：Common，主实例。
CommodityCodeStringAnalyticDB for MySQL CODE。

示例

请求示例

  1. http(s)://[Endpoint]/?Action=DescribeDBClusters
  2. &RegionId=cn-hangzhou
  3. &<公共请求参数>

正常返回示例

XML格式

  1.     <Items>
  2.         <DBCluster>
  3.             <DBVersion>3.0</DBVersion>
  4.             <LockMode>Unlock</LockMode>
  5.             <DBClusterDescription>am-bp*********</DBClusterDescription>
  6.             <DBNodeCount>2</DBNodeCount>
  7.             <DBClusterId>am-bp*********/DBClusterId>
  8.             <DBClusterStatus>Running</DBClusterStatus>
  9.             <Tags></Tags>
  10.             <ExpireTime>2019-11-11T16:00:00Z</ExpireTime>
  11.             <RegionId>cn-hangzhou</RegionId>
  12.             <Expired>false</Expired>
  13.             <CreateTime>2019-09-11T11:33:11Z</CreateTime>
  14.             <DBNodeClass>C8</DBNodeClass>
  15.             <DBClusterType>Common</DBClusterType>
  16.             <LockReason></LockReason>
  17.             <PayType>Prepaid</PayType>
  18.             <DBNodeStorage>100</DBNodeStorage>
  19.         </DBCluster>
  20.     </Items>
  21.     <PageNumber>1</PageNumber>
  22.     <TotalCount>1</TotalCount>
  23.     <PageSize>30</PageSize>
  24.     <RequestId>F5178C10-1407-4987-9133-DE4DC9119F75</RequestId>

JSON格式

  1. {
  2.   "Items": {
  3.     "DBCluster": [
  4.       {
  5.         "DBVersion": "3.0",
  6.         "LockMode": "Unlock",
  7.         "DBClusterDescription": "am-bp*********",
  8.         "DBNodeCount": 2,
  9.         "DBClusterId": "am-bp*********",
  10.         "DBClusterStatus": "Running",
  11.         "Tags": {
  12.           "Tag": []
  13.         },
  14.         "ExpireTime": "2019-11-11T16:00:00Z",
  15.         "RegionId": "cn-hangzhou",
  16.         "Expired": false,
  17.         "CreateTime": "2019-09-11T11:33:11Z",
  18.         "DBNodeClass": "C8",
  19.         "DBClusterType": "Common",
  20.         "LockReason": "",
  21.         "PayType": "Prepaid",
  22.         "DBNodeStorage": 100
  23.       }
  24.     ]
  25.   },
  26.   "PageNumber": 1,
  27.   "TotalCount": 1,
  28.   "PageSize": 30,
  29.   "RequestId": "F5178C10-1407-4987-9133-DE4DC9119F75"
  30. }
版权声明

本文仅代表作者观点，不代表本站立场。
本文系作者授权发表，未经许可，不得转载。

评论

-----