调用DescribeDBInstances接口查询RDS实例列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeDBInstances

系统规定参数，取值：DescribeDBInstances。

RegionId String 是 cn-hangzhou

地域ID，可以通过接口DescribeRegions查看。

ClientToken String 否 ETnLKlblzczshOTUbOCzxxxxxxx

用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符，且该参数值中不能包含非ASCII字符。
proxyId String 否 API

代理模式ID。
Engine String 否 MySQL

数据库类型，取值：

  • MySQL
  • SQLServer
  • PostgreSQL
  • PPAS
  • MariaDB

默认返回所有数据库类型。
ZoneId String 否 cn-hangzhou-a

可用区ID。
ResourceGroupId String 否 rg-acfmyxxxxx

资源组ID。
DBInstanceStatus String 否 Running

实例状态，详情请参见实例状态表。

Expired String 否 True

实例的过期状态，取值：

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

可基于实例ID或者实例备注模糊搜索。
DBInstanceId String 否 rm-uf6wjk5xxxxxxx

实例ID。可调用DescribeDBInstances获取。

DBInstanceType String 否 Primary

实例类型，取值：

  • Primary：主实例
  • Readonly：只读实例
  • Guard：灾备实例
  • Temp：临时实例

默认返回所有实例类型。
PageSize Integer 否 30

每页记录数，取值：1~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：数据库代理模式

默认返回所有访问模式下的实例。
Tags String 否 {"key1":"value1"}

查询绑定有该标签的实例，包括TagKey和TagValue。单次最多支持传入5组值，格式：{"key1":"value1","key2":"value2"...}。
DedicatedHostGroupId String 否 dhg-7a9xxxxxxxx

专属集群ID。
DedicatedHostId String 否 i-bpxxxxxxx

专属集群内的主机ID。
InstanceLevel Integer 否 0

是否返回实例系列（Category）信息，取值：

  • 0：不返回
  • 1：返回
ConnectionString String 否 rm-uf6wjk5xxxxxxx.mysql.rds.aliyuncs.com

实例的连接地址。通过该连接地址查询对应的实例。

返回数据

名称 类型 示例值 描述
PageRecordCount Integer 10

当前页实例个数。
TotalRecordCount Integer 100

总记录数。
PageNumber Integer 1

页码。
Items Array of DBInstance

由实例信息组成的数组。
DBInstance
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。
Category String Basic

实例系列：

  • Basic：基础版
  • HighAvailability：高可用版
  • Finance：三节点企业版
ConnectionString String rm-uf6wjk5xxxxxxx.mysql.rds.aliyuncs.com

实例的连接地址。
CreateTime String 2018-11-05T11:26:02Z

创建时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

DBInstanceClass String rds.mys2.small

实例规格，详见实例规格表。

DBInstanceStorageType String ModuleList.4.ModuleCode

实例储存类型。
DedicatedHostGroupId String dhg-7a9xxxxxxxx

专属集群ID。
DedicatedHostGroupName String testhostgroup

专属集群名称。
DedicatedHostIdForLog String dh-bpxxxx

Log节点所在主机的ID。
DedicatedHostIdForMaster String dh-bpxxxx

Master节点所在主机的ID。
DedicatedHostIdForSlave String dh-bpxxxx

Slave节点所在主机的ID。
DedicatedHostNameForLog String testlog

Log节点所在主机的名称。
DedicatedHostNameForMaster String testmaster

Master节点所在主机的名称。
DedicatedHostNameForSlave String testslave

Slave节点所在主机的名称。
DedicatedHostZoneIdForLog String cn-hangzhou-b

Log节点所在主机的可用区ID。
DedicatedHostZoneIdForMaster String cn-hangzhou-c

Master节点所在主机的可用区ID。
DedicatedHostZoneIdForSlave String cn-hangzhou-d

Slave节点所在主机的可用区ID。
DestroyTime String 2018-11-05T11:26:02Z

销毁时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

EngineVersion String 5.7

数据库版本。
GeneralGroupName String TestGroup

专属集群MySQL通用版实例所属的组名。
MutriORsignle Boolean true

是否是组合可用区。取值：true | false

说明 组合可用区即带有MAZ字样的可用区。例如：cn-hangzhou-MAZ10(h,i)。
ReadOnlyDBInstanceIds Array of ReadOnlyDBInstanceId

主实例下如果有只读实例，该参数为只读实例的ID列表。
ReadOnlyDBInstanceId
DBInstanceId String rr-uf6wjk5xxxxxxx

只读实例ID。
ResourceGroupId String rg-acfmyxxxxxxx

资源组ID。
SwitchWeight Integer 100

当前专属集群MySQL通用版实例是否支持高可用权重切换。返回值：

  • 100：支持切换。
  • 0：不支持切换。
Tips String 一切正常

专属集群MySQL通用版实例的异常提示信息。
TipsLevel Integer 1

专属集群MySQL通用版实例的异常提示等级。返回值：

  • 1：正常。
  • 2：只读实例和主实例规格不对齐，可能影响可用性，请按需调整实例规格。
VSwitchId String vsw-uf6adz52c2pxxxxxxx

交换机ID。
VpcCloudInstanceId String rm-uf6wjk5xxxxxxx

专有网络实例ID。
VpcId String vpc-uf6f7l4fg90xxxxxxx

VPC ID。
VpcName String test-huadong

VPC名称。
ZoneId String cn-hangzhou-a

可用区ID。
RequestId String 1AD222E9-E606-4A42-BF6D-8A4442913CEF

请求ID。

示例

请求示例

http(s)://rds.aliyuncs.com/?Action=DescribeDBInstances
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML格式 

<DescribeDBInstancesResponse>
  <TotalRecordCount>1</TotalRecordCount>
  <PageRecordCount>1</PageRecordCount>
  <RequestId>B4309486-26EF-47B3-ADDE-6140B4C1109D</RequestId>
  <PageNumber>1</PageNumber>
  <Items>
        <DBInstance>
              <ResourceGroupId>rg-acxxxxx</ResourceGroupId>
              <DBInstanceNetType>Intranet</DBInstanceNetType>
              <DBInstanceType>Primary</DBInstanceType>
              <MutriORsignle>false</MutriORsignle>
              <InstanceNetworkType>VPC</InstanceNetworkType>
              <DBInstanceId>rm-bpxxxxx</DBInstanceId>
              <ReadOnlyDBInstanceIds>
        </ReadOnlyDBInstanceIds>
              <LockReason></LockReason>
              <DBInstanceDescription>test</DBInstanceDescription>
              <Engine>MySQL</Engine>
              <EngineVersion>8.0</EngineVersion>
              <DBInstanceStatus>Running</DBInstanceStatus>
              <ZoneId>cn-hangzhou-h</ZoneId>
              <DBInstanceClass>rds.mysql.s3.large</DBInstanceClass>
              <CreateTime>2020-06-17T09:03:57Z</CreateTime>
              <VSwitchId>vsw-bpxxxxx</VSwitchId>
              <PayType>Prepaid</PayType>
              <LockMode>Unlock</LockMode>
              <GuardDBInstanceId>rm-m5xxxxx</GuardDBInstanceId>
              <InsId>1</InsId>
              <VpcId>vpc-bpxxxxx</VpcId>
              <VpcName>test-huadong</VpcName>
              <ConnectionMode>Standard</ConnectionMode>
              <VpcCloudInstanceId>rm-bpxxxxx-1</VpcCloudInstanceId>
              <RegionId>cn-hangzhou</RegionId>
              <ExpireTime>2021-06-17T16:00:00Z</ExpireTime>
        </DBInstance>
  </Items>
</DescribeDBInstancesResponse>

JSON格式 

{
	"TotalRecordCount": 1,
	"PageRecordCount": 1,
	"RequestId": "B4309486-26EF-47B3-ADDE-6140B4C1109D",
	"PageNumber": 1,
	"Items": {
		"DBInstance": [
			{
				"ResourceGroupId": "rg-acxxxxx",
				"DBInstanceNetType": "Intranet",
				"DBInstanceType": "Primary",
				"MutriORsignle": false,
				"InstanceNetworkType": "VPC",
				"DBInstanceId": "rm-bpxxxxx",
				"ReadOnlyDBInstanceIds": {
					"ReadOnlyDBInstanceId": []
				},
				"LockReason": "",
				"DBInstanceDescription": "test",
				"Engine": "MySQL",
				"EngineVersion": "8.0",
				"DBInstanceStatus": "Running",
				"ZoneId": "cn-hangzhou-h",
				"DBInstanceClass": "rds.mysql.s3.large",
				"CreateTime": "2020-06-17T09:03:57Z",
				"VSwitchId": "vsw-bpxxxxx",
				"PayType": "Prepaid",
				"LockMode": "Unlock",
				"GuardDBInstanceId": "rm-m5xxxxx",
				"InsId": 1,
				"VpcId": "vpc-bpxxxxx",
                "VpcName": "test-huadong",
				"ConnectionMode": "Standard",
				"VpcCloudInstanceId": "rm-bpxxxxx-1",
				"RegionId": "cn-hangzhou",
				"ExpireTime": "2021-06-17T16:00:00Z"
			}
		]
	}
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidDBInstanceType.ValueNotSupport The specified parameter"DBInstanceType" is not valid. 操作失败，指定实例类型无效。请选择正确的实例类型。

访问错误中心查看更多错误码。