閱讀751 返回首頁    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 版-阿裏雲