查询指定数据库中schema占用空间大小列表 - QueryingtheStorageUsageofSchemasinaSpecifiedDatabase
调试
您可以在API Explorer中调试该接口。
URI
GET /v3.1/{project_id}/instances/{instance_id}/schema-volume
|
名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
|
instance_id |
是 |
String |
参数解释: 实例ID,此参数是用户创建实例的唯一标识。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为36个字符。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
database_name |
是 |
String |
参数解释: 数据库名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
schema_name |
否 |
String |
参数解释: schema的名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
offset |
否 |
Integer |
参数解释: 索引位置,偏移量。从第一条数据偏移offset条数据后开始查询。 约束限制: 必须为数字,不能为负数。 取值范围: 0 - 10000 默认取值: 0。 |
|
limit |
否 |
Integer |
参数解释: 查询记录数。 约束限制: 不能为负数。 取值范围: 最小值为1,最大值为200。 默认取值: 默认为100。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
schema_volumes |
Array of objects |
数据库schema占用空间列表。详情请参见表5 SchemaVolume。 |
|
total_count |
Integer |
参数解释: 总数。 取值范围: 不涉及。 |
请求示例
查询指定数据库中schema占用空间大小列表。
GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.1/3d39c18788b54a919bab633874c159dfin14/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
}
状态码
- 正常
- 异常
请参见状态码。
错误码
请参见错误码。