该接口用于查询RDS的实例列表。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| rds:DescribeDBInstances | READ |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ClientToken | string | 否 | 用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符，且该参数值中不能包含非ASCII字符。 | ETnLKlblzczshOTUbOCz**** |
| proxyId | string | 否 | 废弃参数，无需配置。 | API |
| Engine | string | 否 | 数据库类型，取值：
默认返回所有数据库类型。 | MySQL |
| ZoneId | string | 否 | 可用区ID。 | cn-hangzhou-a |
| ResourceGroupId | string | 否 | 资源组ID。 | rg-acfmy**** |
| DBInstanceStatus | string | 否 | 实例状态，详情请参见实例状态表。 | Running |
| Expired | string | 否 | 实例的过期状态，取值：
| True |
| SearchKey | string | 否 | 可基于实例ID或者实例备注模糊搜索。 | rm-uf6w |
| DBInstanceId | string | 否 | 实例ID。 | rm-uf6wjk5**** |
| DBInstanceType | string | 否 | 实例类型，取值：
默认返回所有实例类型。 | Primary |
| RegionId | string | 是 | 地域ID。可调用DescribeRegions获取。 | cn-hangzhou |
| PageSize | integer | 否 | 每页记录数，取值：1~100。 默认值：30。 | 30 |
| PageNumber | integer | 否 | 页码，取值：大于0且不超过Integer的最大值。 默认值：1。 | 1 |
| InstanceNetworkType | string | 否 | 实例的网络类型，取值：
默认返回所有网络类型下的实例。 | Classic |
| VpcId | string | 否 | VPC ID。 | vpc-uf6f7l4fg90**** |
| VSwitchId | string | 否 | 交换机ID。 | vsw-uf6adz52c2p**** |
| DBInstanceClass | string | 否 | 实例规格，详见实例规格表。 | rds.mys2.small |
| EngineVersion | string | 否 | 数据库版本。 | 8.0 |
| PayType | string | 否 | 付费类型，取值：
| Postpaid |
| ConnectionMode | string | 否 | 实例的访问模式，取值：
默认返回所有访问模式下的实例。 | Standard |
| Tags | string | 否 | 查询绑定有该标签的实例，包括TagKey和TagValue。单次最多支持传入5组值，格式：{"key1":"value1","key2":"value2"...}。 | {"key1":"value1"} |
| DedicatedHostGroupId | string | 否 | 专属集群ID。 | dhg-7a9**** |
| DedicatedHostId | string | 否 | 专属集群内的主机ID。 | i-bp**** |
| InstanceLevel | integer | 否 | 是否返回实例系列（Category）信息，取值：
| 0 |
| ConnectionString | string | 否 | 实例的连接地址。通过该连接地址查询对应的实例。 | rm-uf6wjk5****.mysql.rds.aliyuncs.com |
| NextToken | string | 否 | 翻页凭证。取值为上一次调用DescribeDBInstances接口时返回的NextToken参数值。如果调用结果分多页展示，再次调用接口时传入该值便可以展示下一页的内容。 | o7PORW5o2TJg**** |
| MaxResults | integer | 否 | 每页记录数。取值：1~100。 默认值：30。 说明
传入该参数，则PageSize和PageNumber参数不可用。
| 30 |
| Filter | string | 否 | 实例过滤条件参数及其值的JSON串 | {"babelfishEnabled":"true"} |
| Category | string | 否 | 实例的系列。取值：
| cluster |
本接口支持如下两种方式查看返回数据：
- 方式一：通过传入MaxResults参数设置每页的记录数，再通过NextToken参数设置翻页凭证来展示下一页的内容。NextToken取值为上一次调用DescribeDBInstances接口返回的NextToken参数值。
说明
首次调用接口进行分页查询时，您只需设置MaxResults参数，接口会返回第一页的数据和NextToken参数值。
- 方式二：通过PageSize参数设置每页的记录数，通过PageNumber参数进行翻页。
说明
上述两种方式只能任选其一。当返回的记录数较多时，推荐使用方式一，可以获得更快的查询速度。
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
"PageNumber": 1,
"PageRecordCount": 10,
"TotalRecordCount": 100,
"Items": {
"DBInstance": [
{
"VpcId": "vpc-uf6f7l4fg90****",
"DedicatedHostIdForLog": "dh-bp****",
"CreateTime": "2018-11-05T11:26:02Z",
"PayType": "Postpaid",
"DedicatedHostNameForLog": "testlog",
"MutriORsignle": true,
"DedicatedHostGroupName": "testhostgroup",
"EngineVersion": "5.7",
"DedicatedHostGroupId": "dhg-7a9****",
"VpcName": "test-huadong",
"DedicatedHostZoneIdForMaster": "cn-hangzhou-c",
"ConnectionString": "rm-uf6wjk5****.mysql.rds.aliyuncs.com",
"InstanceNetworkType": "Classic",
"MasterInstanceId": "rm-uf6wjk5****",
"ExpireTime": "2019-02-27T16:00:00Z",
"DestroyTime": "2018-11-05T11:26:02Z",
"GuardDBInstanceId": "rm-uf64zsu****",
"DedicatedHostNameForMaster": "testmaster",
"ZoneId": "cn-hangzhou-a",
"TipsLevel": 1,
"DBInstanceId": "rm-uf6wjk5****",
"DedicatedHostIdForMaster": "dh-bp****",
"TempDBInstanceId": "rm-uf64zsu****",
"DBInstanceStorageType": "ModuleList.4.ModuleCode",
"ConnectionMode": "Standard",
"LockMode": "Unlock",
"GeneralGroupName": "TestGroup",
"VpcCloudInstanceId": "rm-uf6wjk5****",
"DedicatedHostZoneIdForSlave": "cn-hangzhou-d",
"Tips": "normal",
"DedicatedHostZoneIdForLog": "cn-hangzhou-b",
"DedicatedHostNameForSlave": "testslave",
"DBInstanceDescription": "testdb",
"DBInstanceNetType": "Internet",
"DBInstanceType": "Primary",
"LockReason": "instance_expired",
"DBInstanceStatus": "Running",
"RegionId": "cn-hangzhou",
"VSwitchId": "vsw-uf6adz52c2p****",
"DedicatedHostIdForSlave": "dh-bp****",
"ResourceGroupId": "rg-acfmy****",
"Category": "Basic",
"Engine": "MySQL",
"DBInstanceClass": "rds.mys2.small",
"SwitchWeight": 100,
"ReadOnlyDBInstanceIds": {
"ReadOnlyDBInstanceId": [
{
"DBInstanceId": "rr-uf6wjk5****"
}
]
},
"DeletionProtection": false,
"BurstingEnabled": false,
"BpeEnabled": "0"
}
]
},
"NextToken": "o7PORW5o2TJg****"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | Invalid.NextToken | The parameter NextToken is invalid. | 参数NextToken无效。 |
| 400 | InvalidDBInstanceType.ValueNotSupport | The specified parameter DBInstanceType is not valid. | - |
| 400 | InvalidParameter.OwnerAccount | The specified parameter OwnerAccount is not valid. | 操作失败，参数OwnerAccount不合法，请检查。 |
| 400 | TimeoutRetryLater | Timeout, Please retry later. | - |
| 400 | InvalidExpired.Format | The instance expiration status parameter is incorrect. | 实例过期状态参数有误。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2023-05-26 | OpenAPI 错误码发生变更，OpenAPI 入参发生变更，OpenAPI 返回结构发生变更 | 看变更集 | ||||||||||
| ||||||||||||
| 2023-05-15 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||
| ||||||||||||
| 2023-05-11 | OpenAPI 错误码发生变更，OpenAPI 入参发生变更 | 看变更集 | ||||||||||
| ||||||||||||
| 2022-09-01 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||
| ||||||||||||
| 2022-06-24 | OpenAPI 描述信息更新，OpenAPI 错误码发生变更 | 看变更集 | ||||||||||
| ||||||||||||
| 2021-10-11 | OpenAPI 错误码发生变更，OpenAPI 返回结构发生变更 | 看变更集 | ||||||||||
|
