文档首页/ 云数据库 GaussDB/ API参考/ API（推荐）/ 空间分析/ 查询数据盘空间概况
更新时间：2025-09-11 GMT+08:00
查看PDF
分享

查询数据盘空间概况

功能介绍

查询数据盘空间概况。

调试

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

URI

GET /v3/{project_id}/instances/{instance_id}/database-volume-summary

表1 参数说明

名称

是否必选

说明

project_id

是

参数解释：

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

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

instance_id

是

参数解释：

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

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

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Language

否

String

参数解释：

语言。

约束限制：

不涉及。

取值范围：

  • zh-cn
  • en-us

默认取值：

en-us。

响应参数

表3 响应Body参数

参数

参数类型

描述

data_disk_capacity

String

参数解释：

数据盘总量。

取值范围：

不涉及。

data_disk_usage

String

参数解释：

数据盘使用量。

取值范围：

不涉及。

space_usage_growth_per_day

String

参数解释：

空间使用日均增长量。

取值范围：

不涉及。

estimated_remaining_days

String

参数解释：

预计可用天数。

取值范围：

不涉及。

cn_components

Array of objects

参数解释：

CN节点信息。详情请参见表4。

dn_components

Array of objects

参数解释：

DN节点信息。详情请参见表5。
表4 cn_components

参数

参数类型

描述

node_id

String

参数解释：

节点ID。

取值范围：

不涉及。

component_id

String

参数解释：

组件ID。

取值范围：

不涉及。

node_name

String

参数解释：

节点名称。

取值范围：

不涉及。
表5 dn_components

参数

参数类型

描述

node_id

String

参数解释：

节点ID。

取值范围：

不涉及。

component_id

String

参数解释：

组件ID。

取值范围：

不涉及。

role

String

参数解释：

组件角色。

取值范围：

不涉及。

node_name

String

参数解释：

节点名称。

取值范围：

不涉及。

请求示例

查询数据盘空间概况。

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

响应示例

{
    "data_disk_capacity": "120",
    "data_disk_usage": "11.08",
    "space_usage_growth_per_day": "2.5250",
    "estimated_remaining_days": "43.14",
    "cn_components": [
        {
            "node_id": "7f4659f811d94b3593fe4b590a94b258no14",
            "component_id": "cn_5001",
            "node_name": "gauss-e656_gaussdbv5_hcs2-0_0"
        }
    ],
    "dn_components": [
        {
            "node_id": "7f4659f811d94b3593fe4b590a94b258no14",
            "component_id": "dn_6001",
            "role": "slave",
            "node_name": "gauss-e656_gaussdbv5_hcs2-0_0"
        },
        {
            "node_id": "7f4659f811d94b3593fe4b590a94b258no14",
            "component_id": "dn_6005",
            "role": "slave",
            "node_name": "gauss-e656_gaussdbv5_hcs2-0_0"
        }
    ]
}

状态码

错误码

请参见错误码。

父主题： 空间分析

相关文档