更新时间:2024-03-28 GMT+08:00

查询数据库列表

功能介绍

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

接口约束

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

URI

  • URI格式

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

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    租户在某一Region下的项目ID。

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

    instance_id

    实例ID。

    page

    分页页码,从1开始。

    limit

    每页数据条数。取值范围[1, 100]。

    db-name

    数据库名。当指定该参数时,page和limit参数需要传入但不生效。

    recover_model

    数据库恢复健康模式。取值:

    • FULL:完整模式。
    • SIMPLE:简单模式。
    • BULK_LOGGED:大容量日志恢复模式。

请求消息

  • 请求参数

    无。

  • URI样例

    GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/a8abe84a41364097be7c233c39275087in04/database/detail?page=1&limit=10&db-name=testdb1

响应消息

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

    名称

    参数类型

    说明

    databases

    Array of objects

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

    详情请参见表3

    total_count

    Integer

    数据库总数。

    表3 databases元素结构说明

    名称

    参数类型

    说明

    name

    String

    数据库名称。

    character_set

    String

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

    state

    String

    数据库状态。取值如下:

    • Creating:表示创建中。
    • Running:表示使用中。
    • Deleting:表示删除中。
    • NotExists:表示不存在。
  • 正常响应样例
    {
        "databases": [
            {
                "name": "master",
                "character_set": "Chinese_PRC_CI_AS",
                "state": "Running"
            },
            {
                "name": "msdb",
                "character_set": "Chinese_PRC_CI_AS",
                "state": "Running"
            },
            {
                "name": "model",
                "character_set": "Chinese_PRC_CI_AS",
                "state": "Running"
            },
            {
                "name": "tempdb",
                "character_set": "Chinese_PRC_CI_AS",
                "state": "Running"
            },
            {
                "name": "rdsadmin",
                "character_set": "Chinese_PRC_CI_AS",
                "state": "Running"
            },
            {
                "name": "rds-test",
                "character_set": "Chinese_PRC_CI_AS",
                "state": "Running"
            }
        ],
        "total_count": 6
    }
  • 异常响应

    请参见异常请求结果

状态码

错误码

请参见错误码