阅读751 返回首页    go 阿里云 go 技术社区[云栖]

查看RDS实例列表__实例管理_API 参考_云数据库 RDS 版-阿里云

描述

查看实例列表或被RAM授权的实例列表

请求参数

名称 类型 是否必须 描述
Action String 是 系统规定参数，取值：DescribeDBInstances
RegionId String 是 实例的region，通过函数DescribeRegions查看
Engine String 否 数据库类型，取值范围MySQL/SQLServer/PostgreSQL/PPAS，不填则返回所有
DBInstanceType String 否 实例类型，取值范围：Primary:主实例；Readonly：只读实例；Guard：灾备实例；Temp：临时实例；不填，默认返回所 有
InstanceNetworkType String 否 VPC：返回VPC实例;Classic：返回Classic实例;不填，默认返回所有
ConnectionMode String 否 Performance为标准访问模式;Safty为高安全访问模式;不填，默认返回所有
Tags String 否 查询绑定有该标签的实例，传入值格式为Json string,包括TagKey和TagValue，TagKey不能为空，TagValue可以为空。
格式示例：{“key1”:”value1”}
PageSize Integer 否 每页记录数，取值：30/50/100默认值：30
PageNumber Integer 否 页码，大于0，且不超过Integer的最大值,默认值：1

返回参数

名称 类型 描述
<公共返回参数> 详见附录
Databases List<Database> 由Database组成的数据
PageNumber Integer 页码
TotalRecordCount Integer 总记录数
PageRecordCount Integer 本页DBInstance个数
Items List<DBInstance> 由DBInstance组成的数组

DBInstance的参数

名称 类型 描述
DBInstanceId String 实例名
DBInstanceDescription String 实例描述
PayType String 付费类型 Postpaid:按量付费；Prepaid：预付费
DBInstanceType String Primary:主实例；ReadOnly：只读实例；Guard：灾备实例；Temp：临时实例
InstanceNetworkType String Classic：经典网络;VPC：VPC网络
ConnectionMode String Performance为标准访问模式;Safty为高安全访问模式
RegionId String 地域
ExpireTime String 到期时间，按量付费实例无到期时间
DBInstanceStatus String 详见附录
Engine String 数据库类型
DBInstanceNetType String Internet：外网；Intranet：内网
LockMode String Unlock:正常；ManualLock:手动触发锁定；LockByExpiration:实例过期自动锁定；LockByRestoration:实例回滚前的自动锁定；LockByDiskQuota:实例空间满自动
LockReason String 被锁定的原因
MasterInstanceId String 主实例的ID，如果没有返回此参数（即为null）则表示该实例是主实例
GuardDBInstanceId String 该实例如果挂载着灾备实例。备实例的ID
TempDBInstanceId String 该实例如果挂载着临时实例。临时实例ID
ReadOnlyDBInstanceId List<ReadOnlyDBInstanceId> 主实例下挂载的只读实例ID列表

ReadOnlyDBInstanceId参数

名称 类型 描述
ReadOnlyDBInstanceId String 只读实例Id

示例

  • 请求示例
  1. https://rds.aliyuncs.com/?Action=DescribeDBInstances
  2. &RegionId=cn-hangzhou
  3. &Engine=MySQL
  4. &<公共请求参数>
  • 返回示例

XML格式：

  1. <DescribeDBInstancesResponse>
  2. <PageRecordCount>2</PageRecordCount>
  3. <Items>
  4. <DBInstance>
  5. <DBInstanceDescription>testforRemarks</DBInstanceDescription>
  6. <ExpireTime>2014-10-10T16:00:00Z</ExpireTime>
  7. <DBInstanceId>rdsmjfirvmjfirv</DBInstanceId>
  8. <DBInstanceNetType>Internet</DBInstanceNetType>
  9. <PayType>Prepaid</PayType>
  10. <DBInstanceStatus>Running</DBInstanceStatus>
  11. <DBInstanceType>Primary</DBInstanceType>
  12. <Engine>MySQL</Engine>
  13. <LockMode>Unlock</LockMode>
  14. <LockReason></LockReason>
  15. <RegionId>cn-hangzhou</RegionId>
  16. <ZoneId>cn-hangzhou-a</ZoneId>
  17. <MasterInstanceId></MasterInstanceId>
  18. <GuardDBInstanceId></GuardDBInstanceId>
  19. <TempDBInstanceId></TempDBInstanceId>
  20. <ReadOnlyDBInstanceIds>
  21.       <ReadOnlyDBInstanceId></ReadOnlyDBInstanceId>
  22.    </ReadOnlyDBInstanceIds> 
  23. </DBInstance>
  24. <DBInstance>
  25. <DBInstanceDescription>testforcreate</DBInstanceDescription>
  26. <ExpireTime></ExpireTime>
  27. <DBInstanceId>rdsabqumfabqumf</DBInstanceId>
  28. <DBInstanceNetType>Intranet</DBInstanceNetType>
  29. <PayType>Postpaid</PayType>
  30. <DBInstanceStatus>Running</DBInstanceStatus>
  31. <DBInstanceType>Primary</DBInstanceType>
  32. <Engine>MySQL</Engine>
  33. <LockMode>Unlock</LockMode>
  34. <LockReason></LockReason>
  35. <RegionId>cn-hangzhou</RegionId>
  36. <MasterInstanceId></MasterInstanceId>
  37. <GuardDBInstanceId></GuardDBInstanceId>
  38. <TempDBInstanceId></TempDBInstanceId>
  39. <ReadOnlyDBInstanceIds>
  40.        <ReadOnlyDBInstanceId></ReadOnlyDBInstanceId>
  41.     </ReadOnlyDBInstanceIds> 
  42. </DBInstance>
  43. </Items>
  44. <PageNumber>1</PageNumber>
  45. <TotalRecordCount>2</TotalRecordCount>
  46. <RequestId>2553A660-E4EB-4AF4-A402-8AFF70A49143</RequestId>
  47. </DescribeDBInstancesResponse>

JSON格式： 

  1.  {
  2.     "PageNumber": 1, 
  3.     "Items": {
  4.       "DBInstance": [
  5.         {
  6.           "Engine": "MySQL", 
  7.           "DBInstanceType": "Primary", 
  8.           "DBInstanceStatus": "Running", 
  9.           "DBInstanceDescription": "testforRemarks", 
  10.           "LockMode": "Unlock", 
  11.           "RegionId": "cn-hangzhou", 
  12. "ZoneId": "cn-hangzhou-a", 
  13.           "DBInstanceId": "rdsmjfirvmjfirv", 
  14.           "PayType": "Prepaid", 
  15.           "ExpireTime": "2014-10-10T16:00:00Z", 
  16.           "DBInstanceNetType": "Internet", 
  17.           "LockReason": "",
  18.           "MasterInstanceId": "",
  19.           "GuardDBInstanceId ": "",
  20.           "TempDBInstanceId": "",
  21. "ReadOnlyDBInstanceIds": {
  22.                  "ReadOnlyDBInstanceId": []
  23.                 }
  24.         }, 
  25.         {
  26.           "Engine": "MySQL", 
  27.           "DBInstanceType": "Primary", 
  28.           "DBInstanceStatus": "Running", 
  29.           "DBInstanceDescription": "testforcreate", 
  30.           "LockMode": "Unlock", 
  31.           "RegionId": "cn-hangzhou", 
  32.           "DBInstanceId": "rdsabqumfabqumf", 
  33.           "PayType": "Postpaid", 
  34.           "ExpireTime": "", 
  35.           "DBInstanceNetType": "Intranet", 
  36.           "LockReason": "",
  37. "MasterInstanceId": "",
  38.           "GuardDBInstanceId ": "",
  39.           "TempDBInstanceId": "",
  40. "ReadOnlyDBInstanceIds": {
  41.                  "ReadOnlyDBInstanceId": []
  42.                 }
  43.         }
  44. ]
  45.     } , 
  46.     "TotalRecordCount": 2, 
  47.     "PageRecordCount": 2, 
  48. "RequestId": "2553A660-E4EB-4AF4-A402-8AFF70A49143"
  49. }

最后更新：2016-11-23 16:03:53

  上一篇：go 查看RDS实例详情__实例管理_API 参考_云数据库 RDS 版-阿里云
  下一篇：go 变更RDS实例规格__实例管理_API 参考_云数据库 RDS 版-阿里云