文档首页/ 智能边缘云 IEC/ API参考/ API/ 边缘硬盘/ 查询硬盘列表
更新时间：2024-03-21 GMT+08:00
查看PDF
分享

查询硬盘列表

功能介绍

查询硬盘列表。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/cloudvolumes

表1 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

查询硬盘列表当前页面的数量。 取值范围：0~1000

name

否

String

根据名称查询硬盘列表。

offset

否

Integer

查询的偏移量。默认为0，取值：大于0。

status

否

String

根据状态查询硬盘列表。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

count

Integer

硬盘数量。

volumes

Array of Volume objects

硬盘列表。
表4 Volume

参数

参数类型

描述

id

String

硬盘ID。

status

String

磁盘状态。

size

Integer

磁盘大小。

availability_zone

String

硬盘所属的AZ信息。

attachments

Array of Attachment objects

硬盘的挂载信息。

name

String

磁盘名称。

description

String

描述。

volume_type

String

磁盘类型。

bootable

String

显示这个卷是否可启动。

encrypted

Boolean

显示该卷是否已被加密。

multiattach

Boolean

磁盘是否多挂载。

metadata

Map<String,String>

硬盘的元数据。
表5 Attachment

参数

参数类型

描述

attachment_id

String

挂载信息对应的ID。

device

String

挂载点。

host_name

String

边缘硬盘挂载到的边缘实例对应的物理主机的名称。

id

String

挂载的资源ID。

server_id

String

硬盘挂载到的边缘实例的ID。

volume_id

String

磁盘ID。

请求示例

GET https://{endpoint}/v1/cloudvolumes

响应示例

无

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 边缘硬盘

相关文档