# 查询指定数据库中schema占用空间大小列表 - QueryingtheStorageUsageofSchemasinaSpecifiedDatabase #### 功能介绍 查询指定数据库中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=ListSchemaVolumes)中调试该接口。 #### URI GET /v3.1/{project_id}/instances/{instance_id}/schema-volume 表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个字符。 **默认取值** **：** 不涉及。 | 表2Query参数 | **参数** | **是否必选** | **参数类型** | **描述** | |:---|:---|:---|:---| | database_name | 是 | String | **参数解释** **：** 数据库名称。 **约束限制** **：** 不涉及。 **取值范围** **：** 不涉及。 **默认取值** **：** 不涉及。 | | schema_name | 否 | String | **参数解释** **：** schema的名称。 **约束限制** **：** 不涉及。 **取值范围** **：** 不涉及。 **默认取值** **：** 不涉及。 | | offset | 否 | Integer | **参数解释** **：** 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。 **约束限制** **：** 必须为数字，不能为负数。 **取值范围** **：** 0 - 10000 **默认取值** **：** 0。 | | limit | 否 | Integer | **参数解释** **：** 查询记录数。 **约束限制** **：** 不能为负数。 **取值范围** **：** 最小值为1，最大值为200。 **默认取值** **：** 默认为100。 | #### 请求参数 表3请求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** | #### 响应参数 表4响应Body参数 | **参数** | **参数类型** | **描述** | |:---|:---|:---| | schema_volumes | Array of objects | **参数解释** **：** 数据库schema占用空间列表。详情请参见[表5 SchemaVolume]。 | | total_count | Integer | **参数解释** **：** 数据库schema占用空间列表总数。 **取值范围** **：** 不涉及。 | 表5SchemaVolume | **参数** | **参数类型** | **描述** | |:---|:---|:---| | schema_size | String | **参数解释** **：** schema的大小。单位：MB。 **取值范围** **：** 不涉及。 | | table_count | String | **参数解释** **：** schema拥有的表数量。 **取值范围** **：** 不涉及。 | | user_name | String | **参数解释** **：** schema所属用户名称。 **取值范围** **：** 不涉及。 | | schema_name | String | **参数解释** **：** schema名称空间的名称。 **取值范围** **：** 不涉及。 | #### 请求示例 查询指定数据库中schema占用空间大小列表。 ``` GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.1/4a89780fa1024361bcb855fed6aab89e/instances/3d39c18788b54a919bab633874c159dfin01/schema-volume?database_name=test_db ``` #### 响应示例 ``` { "schema_volumes": [ { "schema_size": "28 MB", "table_count": "161", "user_name": "rdsAdmin", "schema_name": "pg_catalog" } ], "total_count": 1 } ``` #### 状态码 - 正常 200 - 异常 请参见[状态码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_194.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_195.html)。