# 查询实例磁盘信息-QueryingInstanceDiskInformation #### 接口说明 查询实例磁盘信息。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=DDS&api=ShowDiskUsage)中调试该接口。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dds/dds_api_permission.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | dds:instance:getDiskUsage | read | instance | [g:EnterpriseProjectId](https://support.huaweicloud.com/api-dds/dds_api_0042.html#dds_api_0042__li1539015369314) | dds:instance:list | - | #### URI - URI格式 GET /v3/{project_id}/instances/{instance_id}/disk-usage - URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/520c58ba00a3497e97ce0b9604874dd6in02/disk-usage 表1请求参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 从IAM服务获取的用户Token。请参考[认证鉴权](https://support.huaweicloud.com/api-dds/dds_api_0010.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | project_id | 是 | String | **参数解释：** 租户在某一Region下的项目ID。请参考[获取项目ID](https://support.huaweicloud.com/api-dds/dds_projectid.html)章节获取项目编号。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | instance_id | 是 | String | **参数解释：** 实例ID，可以调用"[查询实例列表和详情-QueryingInstancesandDetails](https://support.huaweicloud.com/api-dds/dds_api_0023.html)"接口获取。如果未申请实例，可以调用"[创建实例-CreatingaDBInstance](https://support.huaweicloud.com/api-dds/dds_api_0020.html)"接口创建。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 请求消息 无。 #### 响应消息 - 参数说明 表2响应Body参数 | 参数 | 参数类型 | 说明 | |:---|:---|:---| | volumes | Array of [表3] objects | **参数解释：** 磁盘信息列表。 **取值范围：** 不涉及。 | 表3DiskVolumes | 参数 | 参数类型 | 说明 | |:---|:---|:---| | entity_id | String | **参数解释：** 实例ID或组ID或节点ID。可以调用"[查询实例列表和详情-QueryingInstancesandDetails](https://support.huaweicloud.com/api-dds/dds_api_0023.html)"接口获取。如果未申请实例，可以调用"[创建实例-CreatingaDBInstance](https://support.huaweicloud.com/api-dds/dds_api_0020.html)"接口创建。 **取值范围：** 不涉及。 | | entity_name | String | **参数解释：** 实例名称或组名称或节点名称。 **取值范围：** 不涉及。 | | group_type | String | **参数解释：** 组类型。 **取值范围：** - mongos，表示集群mongos节点类型。 - shard，表示集群shard节点类型。 - config，表示集群config节点类型。 - replica，表示副本集类型。 - single，表示单节点类型。 - readonly，表示只读节点类型。 | | used | String | **参数解释：** 使用量，保留两位小数，单位(GB)。 **取值范围：** 不涉及。 | | size | String | **参数解释：** 总大小，单位(GB)。 **取值范围：** 不涉及。 | #### 请求示例 ``` GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/520c58ba00a3497e97ce0b9604874dd6in02/disk-usage ``` #### 响应示例 **状态码：200** Success. ``` { "volumes" : [ { "entity_id" : "f04553d9ad2942e7a44facc518dc5699gr02", "entity_name" : "single01", "group_type" : "single", "used" : "3.18", "size" : "60" } ] } ``` #### 状态码 详情请参见[状态码](https://support.huaweicloud.com/api-dds/dds_status_code.html)。 #### 错误码 详情请参见[错误码](https://support.huaweicloud.com/api-dds/dds_error_code.html)。