You need to enable JavaScript to run this app.
导航
云数据库 MySQL 版
  • 文档首页
    • /
  • 云数据库 MySQL 版

DescribeDatabases

最近更新时间：2023.11.21 20:54:03

首次发布时间：2023.02.02 17:41:22

我的收藏

调用 DescribeDatabases 接口查看数据库列表。

请求类型

同步请求。

请求参数

名称类型是否必选示例值描述
InstanceIdString是mysql-r3xq0zdl****实例 ID。
DBNameString否testdb1数据库名称。
PageSizeInteger否1每页记录数，取值最小为 1，且不超过 Integer 的最大值。默认值为 10。
PageNumberInteger否10当前页查询偏移量，取值最小为 1，最大为1000；默认值为 1。

返回参数

名称类型示例值描述
TotalInteger1数据库总数。

Databases

Array of DatabaseObject

[
{
"CharacterSetName": "utf8",
"DBDesc": "这是一段数据库 testdb1 的描述。",
"DBName": "testdb1",
"DBPartition": 0,
"DBStatus": "Available",
"DatabasePrivileges": null,
"DatabasePrivilegesInfo": null
}
]

数据库列表。数据库授权信息。更多关于 Databases 的详细信息，请参见数据结构。

请求示例

POST /?Action=DescribeDatabases&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds.volcengineapi.com
X-Date: 20211202T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mysql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
    "InstanceId":"mysql-4674157d****",
    "DBName":"",
    "PageSize":10,
    "PageNumber":1
}

返回示例

正常返回示例

{
    "ResponseMetadata":{
        "RequestId":"2023011116092131FBB0733F03E98C9690",
        "Action":"DescribeDatabases",
        "Version":"2022-01-01",
        "Service":"rds_mysql",
        "Region":"cn-beijing"
    },
    "Result":{
        "Databases":[
            {
                "CharacterSetName": "utf8",
                "DBDesc": "这是一段数据库 testdb1 的描述。",
                "DBName": "testdb1",
                "DBPartition": 0,
                "DBStatus": "Available",
                "DatabasePrivileges": null,
                "DatabasePrivilegesInfo": null
            },
            {
                "CharacterSetName": "utf8",
                "DBDesc": "这是一段数据库 testdb2 的描述信息。",
                "DBName": "testdb2",
                "DBPartition": 0,
                "DBStatus": "Available",
                "DatabasePrivileges": null,
                "DatabasePrivilegesInfo": null
            }
        ],
        "Total":2
    }
}

错误码

更多详情，请参见错误码。