# 查询数据库SCHEMA列表 - QueryingDatabaseSchemas #### 功能介绍 查询指定实例的数据库SCHEMA列表。 - 调用接口前，您需要了解API [认证鉴权](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_011.html)。 - 调用接口前，您需要提前获取到[地区和终端节点](https://developer.huaweicloud.com/endpoint)。 #### 约束限制 实例在异常或冻结状态下不能执行该操作。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=GaussDBforopenGauss&api=ListDatabaseSchemas)中调试该接口。 #### URI GET /v3/{project_id}/instances/{instance_id}/schemas 表1参数说明 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一Region下的项目ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_196.html)。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**： 不涉及。 | | instance_id | 是 | String | **参数解释：** 实例ID，此参数是用户创建实例的唯一标识。请参考[查询数据库实例列表 - QueryingDBInstances](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_328.html)接口获取实例ID。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为36个字符。 **默认取值** **：** 不涉及。 | | db_name | 是 | String | **参数解释：** 数据库名称。 **约束限制：** 不能和模板库重名。模板库包括postgres， template0 ，template1。 **取值范围：** 字符串长度1～63个字符，由字母、数字或下划线组成。 **默认取值**： 不涉及。 | | offset | 否 | Integer | **参数解释：** 分页符。从第一条数据偏移offset条数据后开始查询。例如：该参数指定为1，limit指定为10，则只展示第11-20条数据。 **约束限制：** 不涉及。 **取值范围：** \[0, 2147483647\] **默认取值**： 默认为0（偏移0条数据，表示从第一条数据开始查询）。 | | limit | 否 | Integer | **参数解释：** 查询记录数。每页显示的条目数量。 **约束限制：** 不涉及。 **取值范围：** \[1, 100\] **默认取值**： 默认为10。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 | | X-Language | 否 | String | **参数解释：** 指定接口返回信息的语言类型。 **约束限制：** 不涉及。 **取值范围：** - **zh-cn**：中文 - **en-us**：英文 **默认取值** **：** **en-us** | #### 响应参数 表3参数说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | database_schemas | Array of objects | **参数解释：** 列表中每个元素表示一个数据库SCHEMA，详情参见[表4]。 | | total_count | Integer | **参数解释：** 数据库SCHEMA总数。 **取值范围：** \[1, 2147483647\]，取决于实际个数。 | 表4database_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 } ``` #### 状态码 - 正常 200 - 异常 请参见[状态码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_194.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_195.html)。