该接口用于查询RDS实例下的数据库信息。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| rds:DescribeDatabases | Read |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBInstanceId | string | 是 | 实例ID。可调用DescribeDBInstances获取。 | rm-uf6wjk5**** |
| DBName | string | 否 | 数据库名称。 | testDB01 |
| DBStatus | string | 否 | 数据库状态，取值：
| Creating |
| PageSize | integer | 否 | 每页记录数，取值：
默认值：30。 | 30 |
| PageNumber | integer | 否 | 页码，取值：大于0且不超过Integer的最大值。 默认值：1。 | 1 |
| ResourceGroupId | string | 否 | 资源组ID。 | rg-acfmy**** |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "2603CA96-B17D-4903-BC04-61A2C829CD94",
"Databases": {
"Database": [
{
"DBDescription": "testdb",
"DBStatus": "Creating",
"DBName": "testDB01",
"DBInstanceId": "rm-uf6wjk5****",
"Engine": "MySQL",
"CharacterSetName": "utf8",
"Collate": "C",
"Ctype": "en_US.utf8",
"ConnLimit": "-1",
"Tablespace": "pg_default",
"ResourceGroupId": "rg-acfmy****",
"Accounts": {
"AccountPrivilegeInfo": [
{
"Account": "test",
"AccountPrivilege": "DMLOnly",
"AccountPrivilegeDetail": "SELECT"
}
]
},
"PageNumber": 1,
"PageSize": 30,
"TotalCount": 5,
"BasicInfo": {
"BasicDbProperty": [
{
"allowedValues": [
"CHECKSUM"
],
"databasePropertyName": "page_verify",
"allowModify": true,
"excludeLock": "0",
"currentValue": "CHECKSUM"
}
]
},
"RuntimeInfo": {
"RuntimeDbProperty": [
{
"allowedValues": [],
"databasePropertyName": "TotalDataSizeInMB",
"allowModify": false,
"currentValue": "5.38"
}
]
},
"AdvancedInfo": {
"AdvancedDbProperty": [
{
"allowedValues": [
"OFF",
"ON"
],
"databasePropertyName": "ansi_nulls",
"allowModify": true,
"excludeLock": "0",
"currentValue": "OFF"
}
]
}
}
]
}
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | Database.ConnectError | Database connect error. please check instance status and database processlist | 数据库连接异常，请检查实例状态及数据库的连接池 |
| 400 | InvalidDBInstanceStatus.NotSupport | The Specified instance status is not supported to query account list. | - |
| 400 | Database.QueryError | Query Db failed, please check input value and instance status. | 查询数据库失败，请检查输入参数及实例状态。 |
| 400 | SqlExcutionFailed | Database is in transition. Try the statement later. | 数据库正在变更，请稍后再试。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||||
|---|---|---|---|---|---|---|---|---|
| 2023-08-09 | OpenAPI 错误码发生变更 | 看变更集 | ||||||
| ||||||||
| 2023-06-21 | OpenAPI 错误码发生变更，OpenAPI 返回结构发生变更 | 看变更集 | ||||||
| ||||||||
| 2023-03-24 | OpenAPI 错误码发生变更 | 看变更集 | ||||||
| ||||||||
| 2023-01-06 | OpenAPI 错误码发生变更 | 看变更集 | ||||||
| ||||||||
| 2022-09-15 | OpenAPI 错误码发生变更，OpenAPI 返回结构发生变更 | 看变更集 | ||||||
| ||||||||
| 2022-09-15 | OpenAPI 错误码发生变更，OpenAPI 返回结构发生变更 | 看变更集 | ||||||
|
