調用DescribeDBInstances介面查看RDS執行個體列表或被RAM授權的執行個體列表。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

請求參數

名稱 類型 是否必選 樣本值 描述
Action String 是 DescribeDBInstances

系統規定參數，取值：DescribeDBInstances。

RegionId String 是 cn-hangzhou

地區ID，可以通過介面DescribeRegions查看。

ClientToken String 否 ETnLKlblzczshOTUbOCzxxxxxxx

用於保證請求的等冪性，防止重複提交請求。由用戶端產生該參數值，要保證在不同請求間唯一，最大值不超過64個ASCII字元，且該參數值中不能包含非ASCII字元。
Engine String 否 MySQL

資料庫類型，取值：

  • MySQL；
  • SQLServer；
  • PostgreSQL；
  • PPAS；
  • MariaDB。

預設返回所有資料庫類型。
ZoneId String 否 cn-hangzhou-a

可用性區域ID。
DBInstanceStatus String 否 Running

執行個體狀態，詳情請參見執行個體狀態表。

Expired String 否 True

執行個體的到期狀態，取值：

  • True：已到期。
  • False：未到期。
SearchKey String 否 rm-uf6w

可基於執行個體ID或者執行個體備忘模糊搜尋。
DBInstanceId String 否 rm-uf6wjk5xxxxxxx

執行個體ID。
DBInstanceType String 否 Primary

執行個體類型，取值：

  • Primary：主執行個體；
  • Readonly：唯讀執行個體；
  • Guard：災備執行個體；
  • Temp：臨時執行個體。

預設返回所有執行個體類型。
PageSize Integer 否 30

每頁記錄數，取值：

  • 30；
  • 50；
  • 100。

預設值：30。

PageNumber Integer 否 1

頁碼，取值：大於0且不超過Integer的最大值。

預設值：1。

InstanceNetworkType String 否 Classic

執行個體的網路類型，取值：

  • VPC：專用網路下的執行個體；
  • Classic：傳統網路下的執行個體。

預設返回所有網路類型下的執行個體。
VpcId String 否 vpc-uf6f7l4fg90xxxxxxxxxx

VPC ID。
VSwitchId String 否 vsw-uf6adz52c2pxxxxxxxxxx

交換器ID。
DBInstanceClass String 否 rds.mys2.small

執行個體規格，詳見執行個體規格表。

EngineVersion String 否 5.7

資料庫版本。
PayType String 否 Postpaid

付費類型，取值：

  • Postpaid：隨用隨付；
  • Prepaid：訂用帳戶。
ConnectionMode String 否 Standard

執行個體的訪問模式，取值：

  • Standard：標準訪問模式；
  • Safe：資料庫代理模式。

預設返回所有訪問模式下的執行個體。
AccessKeyId String 否 LTAIfCxxxxxxx

阿里雲頒發給使用者的訪問服務所用的密鑰ID。
proxyId String 否 API

代理模式ID。
ResourceGroupId String 否 rg-acfmyxxxxx

資源群組ID。
Tags String 否 {“key1”:”value1”}

查詢繫結有該標籤的執行個體，包括TagKey和TagValue。單次最多支援傳入5組值，格式：{"key1":"value1","key2":"value2"...}。
Tag.1.key String 否 Tagkey1

當前第一組key。需要綁定的Tag，包括TagKey和TagValue，單次最多支援傳入5組值。TagKey不可為空，TagValue可以為空白。
Tag.2.key String 否 Tagkey2

當前第二組key。需要綁定的Tag，包括TagKey和TagValue，單次最多支援傳入5組值。TagKey不可為空，TagValue可以為空白。
Tag.3.key String 否 Tagkey3

當前第三組key。需要綁定的Tag，包括TagKey和TagValue，單次最多支援傳入5組值。TagKey不可為空，TagValue可以為空白。
Tag.4.key String 否 Tagkey4

當前第四組key。需要綁定的Tag，包括TagKey和TagValue，單次最多支援傳入5組值。TagKey不可為空，TagValue可以為空白。
Tag.5.key String 否 Tagkey5

當前第五組key。需要綁定的Tag，包括TagKey和TagValue，單次最多支援傳入5組值。TagKey不可為空，TagValue可以為空白。
Tag.1.value String 否 Tagvalue1

當前第一組value。需要綁定的Tag，包括TagKey和TagValue，單次最多支援傳入5組值。TagKey不可為空，TagValue可以為空白。
Tag.2.value String 否 Tagvalue2

當前第二組value。需要綁定的Tag，包括TagKey和TagValue，單次最多支援傳入5組值。TagKey不可為空，TagValue可以為空白。
Tag.3.value String 否 Tagvalue3

當前第三組value。需要綁定的Tag，包括TagKey和TagValue，單次最多支援傳入5組值。TagKey不可為空，TagValue可以為空白。
Tag.4.value String 否 Tagvalue4

當前第四組value。需要綁定的Tag，包括TagKey和TagValue，單次最多支援傳入5組值。TagKey不可為空，TagValue可以為空白。
Tag.5.value String 否 Tagvalue5

當前第五組value。需要綁定的Tag，包括TagKey和TagValue，單次最多支援傳入5組值。TagKey不可為空，TagValue可以為空白。

返回資料

名稱 類型 樣本值 描述
PageRecordCount Integer 10

當前頁執行個體個數。
TotalRecordCount Integer 100

總記錄數。
PageNumber Integer 1

頁碼。
RequestId String 1AD222E9-E606-4A42-BF6D-8A4442913CEF

請求ID。
Items

由執行個體資訊組成的數組。
DBInstanceId String rm-uf6wjk5xxxxxxxxxx

執行個體ID。
DBInstanceDescription String 測試資料庫

執行個體描述。
PayType String Postpaid

執行個體的付費類型，取值：

  • Postpaid：隨用隨付；
  • Prepaid：訂用帳戶。
DBInstanceType String Primary

執行個體類型，取值：

  • Primary：主執行個體；
  • ReadOnly：唯讀執行個體；
  • Guard：災備執行個體；
  • Temp：臨時執行個體。
InstanceNetworkType String Classic

執行個體的網路類型，取值：

  • Classic：傳統網路；
  • VPC：VPC網路。
ConnectionMode String Performance

執行個體的訪問模式，取值：

  • Standard：標準訪問模式；
  • Safe：資料庫代理模式。
RegionId String cn-hangzhou

地區ID。
ExpireTime String 2019-02-27T16:00:00Z

到期時間。格式：yyyy-MM-ddTHH:mm:ssZ（UTC時間）。

说明 隨用隨付執行個體無到期時間。
DBInstanceStatus String Running

執行個體狀態，詳情請參見執行個體狀態表。

Engine String MySQL

資料庫類型。
DBInstanceNetType String Internet

執行個體的網路連接類型，取值：

  • Internet：外網串連；
  • Intranet：內網串連。
LockMode String Unlock

執行個體的鎖定狀態。取值：

  • Unlock：正常；
  • ManualLock：手動觸發鎖定；
  • LockByExpiration：執行個體到期自動鎖定；
  • LockByRestoration：執行個體復原前自動鎖定；
  • LockByDiskQuota：執行個體空間滿自動鎖定；
  • Released：執行個體已釋放。此時執行個體無法進行解鎖，只能使用備份資料重新建立新執行個體，重建時間較長，請耐心等待。
LockReason String instance_expired

執行個體被鎖定的原因。
MasterInstanceId String rm-uf6wjk5xxxxxxxxxx

主執行個體的ID，如果沒有返回此參數（即為null）則表示該執行個體是主執行個體。
GuardDBInstanceId String rm-uf64zsuxxxxxxxxxx

主執行個體如果有災備執行個體，該參數即為災備執行個體的ID。
TempDBInstanceId String rm-uf64zsuxxxxxxxxxx

主執行個體如果有臨時執行個體，該參數即為臨時執行個體的ID。
AutoUpgradeMinorVersion String Auto

執行個體升級小版本的方式，取值：

  • Auto：自動升級小版本；
  • Manual：不自動升級，僅在目前的版本下線時才強制升級。
Category String Basic

執行個體系列：

  • Basic：基礎版；
  • HighAvailability：高可用版；
  • Finance：金融版（僅支援中國站）。
CreateTime String 2018-11-05T11:26:02Z

建立時間。格式：yyyy-MM-ddTHH:mm:ssZ（UTC時間）。

DBInstanceClass String rds.mys2.small

執行個體規格，詳見執行個體規格表。

DBInstanceStorageType String ModuleList.4.ModuleCode

執行個體儲存類型。
DestroyTime String 2018-11-05T11:26:02Z

銷毀時間。格式：yyyy-MM-ddTHH:mm:ssZ（UTC時間）。

EngineVersion String 5.7

資料庫版本。
MutriORsignle Boolean true

是否是多可用性區域，取值：true | false
ReadOnlyDBInstanceIds

主執行個體下如果有唯讀執行個體，該參數為唯讀執行個體的ID列表。
DBInstanceId String rr-uf6wjk5xxxxxxx

唯讀執行個體ID。
ResourceGroupId String rg-acfmyxxxxxxx

資源群組ID。
VSwitchId String vsw-uf6adz52c2pxxxxxxx

交換器ID。
VpcCloudInstanceId String rm-uf6wjk5xxxxxxx

專用網路執行個體ID。
VpcId String vpc-uf6f7l4fg90xxxxxxx

VPC ID。
ZoneId String cn-hangzhou-a

可用性區域ID。

樣本

請求樣本


http(s)://rds.aliyuncs.com/?Action=DescribeDBInstances
&RegionId=cn-hangzhou
&<公用請求參數>

正常返回樣本

XML 格式 

<DescribeDBInstancesResponse>
  <Items>
		    <DBInstance>
			      <LockMode>Unlock</LockMode>
			      <DBInstanceNetType>Intranet</DBInstanceNetType>
			      <DBInstanceClass>ppas.x4.xlarge.2</DBInstanceClass>
			      <ResourceGroupId>rg-acfnt75uxxxxx</ResourceGroupId>
			      <DBInstanceId>rm-dj120j44xxxxx</DBInstanceId>
			      <VpcCloudInstanceId></VpcCloudInstanceId>
			      <ZoneId>cn-beijing-MAZ3(c,e)</ZoneId>
			      <ReadOnlyDBInstanceIds></ReadOnlyDBInstanceIds>
			      <ConnectionMode>Standard</ConnectionMode>
			      <InstanceNetworkType>Classic</InstanceNetworkType>
			      <Engine>PPAS</Engine>
			      <MutriORsignle>true</MutriORsignle>
			      <InsId>1</InsId>
			      <ExpireTime></ExpireTime>
			      <CreateTime>2019-03-20T02:18:02Z</CreateTime>
			      <DBInstanceType>Primary</DBInstanceType>
			      <RegionId>cn-beijing</RegionId>
			      <EngineVersion>10.0</EngineVersion>
			      <LockReason></LockReason>
			      <DBInstanceStatus>Running</DBInstanceStatus>
			      <PayType>Postpaid</PayType>
		    </DBInstance>
	  </Items>
	  <TotalRecordCount>1</TotalRecordCount>
	  <PageNumber>1</PageNumber>
	  <RequestId>0C2B0363-2707-4300-9900-0A65846CE48E</RequestId>
	  <PageRecordCount>1</PageRecordCount>
</DescribeDBInstancesResponse>

JSON 格式 

{
	"Items":{
		"DBInstance":[
			{
				"LockMode":"Unlock",
				"DBInstanceNetType":"Intranet",
				"DBInstanceClass":"ppas.x4.xlarge.2",
				"ResourceGroupId":"rg-acfnt75uxxxxx",
				"DBInstanceId":"rm-dj120j44xxxxx",
				"VpcCloudInstanceId":"",
				"ZoneId":"cn-beijing-MAZ3(c,e)",
				"ReadOnlyDBInstanceIds":{
					"ReadOnlyDBInstanceId":[]
				},
				"ConnectionMode":"Standard",
				"InstanceNetworkType":"Classic",
				"Engine":"PPAS",
				"MutriORsignle":true,
				"InsId":1,
				"ExpireTime":"",
				"RegionId":"cn-beijing",
				"DBInstanceType":"Primary",
				"CreateTime":"2019-03-20T02:18:02Z",
				"LockReason":"",
				"EngineVersion":"10.0",
				"DBInstanceStatus":"Running",
				"PayType":"Postpaid"
			}
		]
	},
	"PageNumber":1,
	"TotalRecordCount":1,
	"RequestId":"0C2B0363-2707-4300-9900-0A65846CE48E",
	"PageRecordCount":1
}

錯誤碼

HttpCode 錯誤碼 錯誤資訊 描述
400 InvalidDBInstanceType.ValueNotSupport The specified parameter"DBInstanceType" is not valid. 參數DBInstanceType無效。

訪問錯誤中心查看更多錯誤碼。