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

查询数据库SCHEMA列表

功能介绍

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

接口约束

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

URI

  • URI格式

    GET /v3/{project_id}/instances/{instance_id}/schema/detail?db_name={name}&page={page}&limit={limit}

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

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

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

    instance_id

    实例ID。

    db_name

    数据库名称。

    不能和RDS for PostgreSQL模板库重名。

    RDS for PostgreSQL模板库包括postgrestemplate0 ,template1

    page

    分页页码,从1开始。

    limit

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

请求消息

  • 请求参数

    无。

  • URI样例

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

响应消息

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

    名称

    参数类型

    说明

    database_schemas

    Array of objects

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

    详情请参见表3

    total_count

    Integer

    数据库schema总数。

    表3 users元素结构说明

    名称

    参数类型

    说明

    schema_name

    String

    schema名称。

    owner

    String

    schema所属用户。

  • 正常响应样例
    {
      "database_schemas": [{
        "schema_name": "rds_user1",
        "owner": "root"
      }],
    "total_count": 1
    }

状态码

错误码

请参见错误码