更新时间:2024-08-20 GMT+08:00
分享

查询数据库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

约束限制:

不涉及。

取值范围:

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

instance_id

String

参数解释:

实例ID。标识实例的唯一标识。

约束限制:

不涉及。

取值范围:

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

db_name

String

参数解释:

数据库名称。

约束限制:

不能和模板库重名。模板库包括postgres, template0 ,template1。

取值范围:

不涉及。

默认取值

不涉及。

offset

Integer

参数解释:

分页符。从第一条数据偏移offset页数据后开始查询。例如:该参数指定为1,limit指定为10,则只展示第11-20条数据。

约束限制:

不涉及。

取值范围:

[0, 2^31-1]

默认取值

默认为0(偏移0条数据,表示从第一条数据开始查询)。

limit

Integer

参数解释:

查询记录数。每页显示的条目数量。

约束限制:

不涉及。

取值范围:

[1, 100]

默认取值

默认为10。

请求参数

无。

响应参数

表2 参数说明

参数

参数类型

描述

database_schemas

Array of objects

参数解释:

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

total_count

Integer

参数解释:

数据库SCHEMA总数。

取值范围:

[1, 2^31-1],取决于实际个数。

表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" : [ { 
    "owner" : "root",
    "schema_name" : "rds-test"
  }, { 
    "owner" : "root",
    "schema_name" : "testdb1" 
  } ], 
  "total_count" : 2 
}

状态码

错误码

请参见错误码

相关文档