# 查询分片磁盘信息 - QueryingShardStorageInformation
#### 功能介绍
查询分片磁盘信息。
- 调用接口前，您需要了解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=ShowShardDiskMessages)中调试该接口。
#### URI
GET /v3/{project_id}/instances/{instance_id}/shard-volume-usage
表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参数列表 
| 名称               | 参数类型             | 说明                                                                                                                                                                                         |
|:---|:---|:---|
| group_disk_infos | Array of objects | **参数解释：** 列表中每个分片磁盘信息，详情参见[表4]。 |
   
 表4group_disk_infos字段数据结构说明 
| 名称       | 参数类型   | 说明                                                                                                                                                                                                                                                                             |
|:---|:---|:---|
| name     | String | **参数解释：** 分片名称。 **取值范围：** 不涉及。             |
| used     | Double | **参数解释：** 分片磁盘使用率，单位：%。 **取值范围：** 不涉及。   |
| total    | Double | **参数解释：** 分片磁盘大小，单位：GB。 **取值范围：** 不涉及。 |
| group_id | String | **参数解释：** 分片组ID。 **取值范围：** 不涉及。           |
   
#### 请求示例
查询分片磁盘信息。
```
GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/ad6d0ae45394494d881786800581afe5in14/shard-volume-usage
```
#### 响应示例
查询分片磁盘信息。
```
{
    "group_disk_infos": [
        {
            "name": "gaussdbv5dn1",
            "used": 6.83,
            "total": 40,
            "group_id": "30c375a15cf4470e80afb0ecdfac00c0gr14"
        },
        {
            "name": "gaussdbv5dn2",
            "used": 44.52,
            "total": 80,
            "group_id": "cc7f8dc312b34b75b94ca00f0c41f6d0gr14"
        }
    ]
}
```
#### 状态码
- 正常 200
  
- 异常 请参见[状态码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_194.html)。
  
 
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_195.html)。