更新时间:2026-03-16 GMT+08:00
分享

查询数据库列表 - ListPostgresqlDatabases

功能介绍

查询指定实例中的数据库列表。

调试

您可以在API Explorer中调试该接口。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

接口约束

  • 实例在异常或冻结状态下不能执行该操作。
  • 不支持查询只读实例的数据库列表。

URI

  • URI格式

    GET /v3/{project_id}/instances/{instance_id}/database/detail?db={db}&page={page}&limit={limit}

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    参数解释:

    租户在某一region下的project ID。

    约束限制:

    非空。

    取值范围:

    获取方法请参见获取项目ID

    默认取值:

    不涉及。

    instance_id

    参数解释:

    实例ID。

    约束限制:

    非空。

    取值范围:

    该参数值可调用查询数据库实例列表接口,通过表4中的“id”获取。

    默认取值:

    不涉及。

    db

    参数解释

    数据库名称,忽略大小写模糊查询。

    约束限制

    不涉及。

    取值范围

    不涉及。

    默认取值

    不涉及。

    page

    参数解释

    分页页码。

    约束限制

    不涉及。

    取值范围

    从1开始。

    默认取值

    不涉及。

    limit

    参数解释

    每页数据条数。

    约束限制

    不涉及。

    取值范围

    [1, 100]

    默认取值

    不涉及。

请求消息

  • 请求参数

    无。

  • URI样例

    GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/f569f1358436479dbcba8603c32cc4aein03/database/detail?page=1&limit=10

响应消息

  • 正常响应要素说明
    表2 要素说明

    名称

    参数类型

    说明

    databases

    Array of objects

    参数解释

    列表中每个元素表示一个数据库。

    详情请参见表3

    total_count

    Integer

    参数解释

    数据库总数。

    取值范围

    不涉及。

    表3 databases元素结构说明

    名称

    参数类型

    说明

    name

    String

    参数解释

    数据库名称。

    取值范围

    不涉及。

    owner

    String

    参数解释

    数据库所属用户。

    取值范围

    不涉及。

    character_set

    String

    参数解释

    数据库使用的字符集,例如UTF8。

    取值范围

    不涉及。

    collate_set

    String

    参数解释

    数据库排序集,例如en_US.UTF-8等。

    取值范围

    不涉及。

    size

    Integer

    参数解释

    数据库大小(单位:字节)。

    取值范围

    不涉及。

    comment

    String

    参数解释

    数据库备注。

    取值范围

    不涉及。

  • 正常响应样例
    {
        "databases": [
            {
                "name": "rds_test",
                "owner": "root",
                "character_set": "UTF8",
                "collate_set":"en_US.UTF-8",
                "size":10777247,
                "comment":"comment"
            },
           {
               "name": "rds_test2",
               "owner":"root",
               "character_set": "UTF8",
               "collate_set":"en_US.UTF-8",
               "size":1055623,
               "comment":"comment"
            },
           {
               "name": "rds_test3",
               "owner":"root",
               "character_set": "UTF8",
               "collate_set":"en_US.UTF-8",
               "size":107772488,
               "comment":"comment"
           }
        ],
        "total_count": 3
    }
  • 异常响应

    请参见异常请求结果

状态码

错误码

请参见错误码

相关文档