查看存储层（如RDS或PolarDB）的实例列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| drds:DescribeDbInstances | get | *instance acs:drds:{#regionId}:{#accountId}:instance/{#instanceId1}/* |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DrdsInstanceId | string | 是 | 实例 ID。 | drds************ |
| Search | string | 否 | 存储层实例 ID 或集群 ID。 | pc-*************** |
| DbInstType | string | 否 | 存储层类型，取值为 POLARDB 或 RDS。 | POLARDB |
| PageNumber | integer | 否 | 分页页码。 | 1 |
| PageSize | integer | 否 | 分页每页大小。 | 10 |
| RegionId | string | 否 | 地域 ID。 | cn-hangzhou |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "293275B3-8FC0-4619-A26E-6F062FASD56R",
"Items": {
"DBInstance": [
{
"InstanceNetworkType": "VPC",
"DBInstanceType": "Primary",
"ZoneId": "cn-hangzhou-a",
"DBInstanceStatus": 0,
"DBInstanceId": "rm-****************",
"Engine": "存储层实例内核。",
"DBInstanceDescription": "test",
"EngineVersion": 5.7,
"RegionId": "cn-hangzhou",
"ReadOnlyDBInstanceId": {
"ReadOnlyDBInstanceId": [
[]
]
},
"AllowAllCategory": true
}
]
}
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | ActionUnauthorized | The specified action is not available for you | 指定的action未授权，请您先做RAM授权再进行操作。 |
| 404 | InvalidDRDSInstanceId.NotFound | The DrdsInstanceId provided does not exist in our records. | - |
| 404 | InvalidDbName.NotFound | The Drds DbName provided does not exist in our records. | - |
| 500 | InternalError | The request processing has failed due to some unknown error. | 请求失败，内部错误 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-04-24 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |