DescribeDatabases--云数据库 veDB MySQL 版-火山引擎

文档中心

立即注册

导航

DescribeDatabases

最近更新时间：2024.11.08 10:14:35首次发布时间：2022.04.12 19:05:15

调用 DescribeDatabases 接口查询指定实例的数据库列表。

请求类型

同步请求。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

名称	类型	是否必选	示例值	描述
InstanceId	String	是	vedbm-r3xq0zdl****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询实例 ID。
PageNumber	Integer	否	1	页码，取值大于等于 1，且不超过 Integer 的最大值，默认值为 1。
PageSize	Integer	否	10	每页记录数。取值范围 1~1000，默认值为 10。
DBName	String	否	testdb1	数据库名称。说明在进行模糊搜索时，下划线（_）不作为通配符使用，而是直接匹配下划线（_）本身。

返回参数

名称	类型	示例值	描述
Total	Integer	2	数据库总数。
Databases	Array of DatabaseObject	请参见返回示例。	数据库列表。详细信息，请参见 DatabaseObject。

请求示例

POST /?Action=DescribeDatabases&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host：vedbm.volcengineapi.com
X-Date: 20220101T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20220101/cn-beijing/vedbm/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645****

{
        "InstanceId": "vedbm-ca12cbqv****",
        "PageNumber" : 1,
        "PageSize" : 10
}

返回示例

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "20240626181457AE8FEFE71A65F50CF16C-44a261",
        "Action": "DescribeDatabases",
        "Version": "2022-01-01",
        "Service": "vedbm",
        "Region": "cn-chongqing-sdv"
    },
    "Result": {
        "Databases": [
            {
                "CharacterSetName": "utf8mb4",
                "DBName": "db1",
                "DatabasesPrivileges": [
                    {
                        "AccountName": "test1",
                        "AccountPrivilege": "DDLOnly",
                        "AccountPrivilegeDetail": "CREATE,DROP,INDEX,ALTER,CREATE TEMPORARY TABLES,LOCK TABLES,CREATE VIEW,SHOW VIEW,CREATE ROUTINE,ALTER ROUTINE"
                    },
                    {
                        "AccountName": "test2",
                        "AccountPrivilege": "Custom",
                        "AccountPrivilegeDetail": "INSERT,UPDATE,DELETE,CREATE"
                    },
                    {
                        "AccountName": "test3",
                        "AccountPrivilege": "ReadWrite",
                        "AccountPrivilegeDetail": "SELECT,INSERT,UPDATE,DELETE,CREATE,DROP,REFERENCES,INDEX,ALTER,CREATE TEMPORARY TABLES,LOCK TABLES,CREATE VIEW,SHOW VIEW,CREATE ROUTINE,ALTER ROUTINE,EXECUTE,EVENT,TRIGGER"
                    }
                ]
            }
        ],
        "Total": 1
    }
}

错误码

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