文档首页/文档数据库服务 DDS/API参考（联盟区域）/API v3（推荐）/实例管理/查询实例磁盘信息
更新时间：2026-01-07 GMT+08:00
查看PDF
分享

查询实例磁盘信息

接口说明

查询实例磁盘信息。

URI

  • URI格式
    GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/disk-usage
    表1 路径参数

    参数

    是否必选

    参数类型

    描述

    project_id

    是

    String

    租户在某一region下的project ID。请参考获取项目ID章节获取项目编号。

    instance_id

    是

    String

    实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

响应参数

表3 响应Body参数

参数

参数类型

说明

volumes

Array of 表3 objects

磁盘信息列表。

表4 DiskVolumes

参数

参数类型

说明

entity_id

String

实例ID或组ID或节点ID。

entity_name

String

实例名称或组名称或节点名称。

group_type

String

group_type。取值范围：

  • mongos，表示集群mongos节点类型。
  • shard，表示集群shard节点类型。
  • config，表示集群config节点类型。
  • replica，表示副本集类型。
  • readonly，表示只读节点类型。

used

String

使用量，保留两位小数，单位(GB)。

size

String

总大小，单位(GB)。

  • 响应示例 
    { 
  "volumes" : [ { 
    "entity_id" : "f04553d9ad2942e7a44facc518dc5699gr02", 
    "entity_name" : "replicaTest", 
    "group_type" : "replica", 
    "used" : "3.18", 
    "size" : "60"
  } ] 
}

状态码

详情请参见状态码。

错误码

详情请参见错误码。

父主题：实例管理