文档首页/ 云数据库 GaussDB/ API参考/ API(推荐)/ 空间分析/ 查询数据库占用空间大小列表 - QueryingDatabaseStorageUsage
更新时间:2025-12-25 GMT+08:00
分享

查询数据库占用空间大小列表 - QueryingDatabaseStorageUsage

功能介绍

查询数据库占用空间大小列表。

调试

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

URI

GET /v3.1/{project_id}/instances/{instance_id}/database-volume

表1 参数说明

名称

是否必选

参数类型

说明

project_id

String

参数解释:

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

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

约束限制:

不涉及。

取值范围:

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

默认取值

不涉及。

instance_id

String

参数解释:

实例ID,此参数是用户创建实例的唯一标识。

约束限制:

不涉及。

取值范围:

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

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

database_name

String

参数解释

数据库名称。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

table_space_name

String

参数解释

数据库的缺省表空间名称。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

user_name

String

参数解释

表所属用户名称。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

offset

Integer

参数解释

索引位置,偏移量。从第一条数据偏移offset条数据后开始查询。

约束限制

不涉及。

取值范围

0 - 10000

默认取值

0

limit

Integer

参数解释

查询记录数。

约束限制

不能为负数。

取值范围

最小值为1,最大值为200。

默认取值

100

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制:

不涉及。

取值范围

不涉及。

默认取值

不涉及。

X-Language

String

参数解释:

语言。

约束限制:

不涉及。

取值范围

  • zh-cn
  • en-us

默认取值

en-us

响应参数

表4 响应Body参数

参数

参数类型

描述

database_volumes

Array of objects

参数解释

数据库占用空间列表。详情请参见表5

total_count

Integer

参数解释

总数。

取值范围

不涉及。

表5 DatabaseVolume

参数

参数类型

描述

database_name

String

参数解释

数据库名称。

取值范围

不涉及。

table_space_name

String

参数解释

数据库的缺省表空间名。

取值范围

不涉及。

user_name

String

参数解释

表所属用户名称。

取值范围

不涉及。

database_size

String

参数解释

数据库占用空间大小。

取值范围

不涉及。

请求示例

查询数据库占用空间大小列表。

GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.1/3d39c18788b54a919bab633874c159dfin14/instances/3d39c18788b54a919bab633874c159dfin01/database-volume

响应示例

{ 
    "database_volumes": [
        {
            "database_name": "postgres",
            "table_space_name": "pg_default",
            "user_name": "rdsAdmin",
            "database_size": "708 MB"
        }
    ],
    "total_count": 1
}

状态码

错误码

请参见错误码

相关文档