# 查询数据盘空间概况 - QueryingDataDiskSpaceUsage #### 功能介绍 查询数据盘空间概况。 - 调用接口前，您需要了解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=ListDatabaseVolumeSummary)中调试该接口。 #### URI GET /v3/{project_id}/instances/{instance_id}/database-volume-summary 表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个字符。 **默认取值** **：** 不涉及。 | #### 请求参数 表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响应Body参数 | **参数** | **参数类型** | **描述** | |:---|:---|:---| | data_disk_capacity | String | **参数解释** **：** 数据盘总量，单位：GB。 **取值范围** **：** 不涉及。 | | data_disk_usage | String | **参数解释** **：** 数据盘使用量，单位：GB。 **取值范围** **：** 不涉及。 | | space_usage_growth_per_day | String | **参数解释** **：** 空间使用日均增长量，单位：GB。 **取值范围** **：** 不涉及。 | | estimated_remaining_days | String | **参数解释** **：** 预计可用天数，单位：天。 **取值范围** **：** 不涉及。 | | cn_components | Array of objects | **参数解释** **：** CN节点信息。详情请参见[表4]。 | | dn_components | Array of objects | **参数解释** **：** DN节点信息。详情请参见[表5]。 | 表4cn_components | **参数** | **参数类型** | **描述** | |:---|:---|:---| | node_id | String | **参数解释** **：** 节点ID。 **取值范围** **：** 不涉及。 | | component_id | String | **参数解释** **：** 组件ID。 **取值范围** **：** 不涉及。 | | node_name | String | **参数解释** **：** 节点名称。 **取值范围** **：** 不涉及。 | 表5dn_components | **参数** | **参数类型** | **描述** | |:---|:---|:---| | node_id | String | **参数解释** **：** 节点ID。 **取值范围** **：** 不涉及。 | | component_id | String | **参数解释** **：** 组件ID。 **取值范围** **：** 不涉及。 | | role | String | **参数解释** **：** 组件角色。 **取值范围** **：** 不涉及。 | | node_name | String | **参数解释** **：** 节点名称。 **取值范围** **：** 不涉及。 | #### 请求示例 查询数据盘空间概况。 ``` GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/4a89780fa1024361bcb855fed6aab89e/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" } ] } ``` #### 状态码 - 正常 200 - 异常 请参见[状态码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_194.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_195.html)。