文档首页> 云数据库 GaussDB> API参考> API（推荐）> 管理数据库和用户> 查询数据库SCHEMA列表
更新时间：2024-05-20 GMT+08:00
查看PDF
分享

查询数据库SCHEMA列表

功能介绍

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

约束限制

实例在异常或冻结状态下不能执行该操作。

调试

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

URI

GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/schemas?db_name={db_name}

表1 参数说明

参数

是否必选

参数类型

描述

project_id

是

String

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

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

instance_id

是

String

实例ID。

db_name

是

String

数据库名称。不能和模板库重名。模板库包括postgres， template0 ，template1。

offset

否

Integer

分页符。从第一条数据偏移offset页数据后开始查询，默认为0（偏移0页数据，表示从第一条数据开始查询），必须为数字，不能为负数。例如：该参数指定为1，limit指定为10，则只展示第11-20条数据。

limit

否

Integer

每页显示的条目数量,取值范围[1, 100]，默认10。

请求参数

无。

响应参数

表2 参数说明

参数

参数类型

描述

database_schemas

Array of objects

列表中每个元素表示一个数据库SCHEMA，详情参见表3。

total_count

Integer

数据库SCHEMA总数。
表3 database_schemas字段数据结构说明

参数

参数类型

描述

schema_name

String

SCHEMA名称。

owner

String

SCHEMA所属用户。

请求示例

GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/{instance_id}/schemas?db_name=dbname

响应示例

{ 
  "database_schemas" : [ { 
    "schema_name" : "rds-test", 
    "owner" : "root" 
  }, { 
    "schema_name" : "testdb1", 
    "owner" : "root" 
  } ], 
  "total_count" : 2 
}

状态码

错误码

请参见错误码。

分享：

    相关文档

    相关产品