- 最新动态
- 功能总览
- 产品介绍
- 快速入门
- 用户指南
- 最佳实践
- API参考
- SDK参考
-
常见问题
- 常见问题汇总
- 云硬盘通用问题
- 云硬盘计费问题
-
云硬盘挂载问题
- 为什么登录到云服务器后看不到已挂载的数据盘
- 云硬盘不支持挂载至云服务器怎么办
- 一块云硬盘可以挂载到多台云服务器上吗
- 云硬盘可以挂载至不同可用区的云服务器吗
- 怎样为云服务器增加数据盘(例如D盘或者dev/vdb1)
- 包年/包月云硬盘可以挂载给其他云服务器吗
- 不同类型的磁盘可以挂载在同一个云服务器上吗
- 系统盘和数据盘之间可以随意转换吗
- Linux系统的云硬盘挂载至Windows系统后需如何处理
- 随包周期云服务器购买的云硬盘,可以挂载至其它包周期云服务器吗
- 随云服务器购买的系统盘或数据盘可以换挂载点吗
- 控制台与弹性云服务器内部之间磁盘挂载点的对应关系
- 云硬盘挂载的包年/包月云服务器已到期,如何查看盘内数据
- 云硬盘扩容问题
- 云硬盘卸载问题
- 云硬盘删除问题
- 云硬盘容量问题
- 云硬盘快照问题
- 云硬盘性能问题
- 共享云硬盘问题
- 云硬盘备份问题
- 视频帮助
- 产品术语
-
更多文档
- 用户指南(阿布扎比区域)
- API参考(阿布扎比区域)
- 用户指南 (巴黎区域)
- API参考 (巴黎区域)
- 用户指南(吉隆坡区域)
- API参考(吉隆坡区域)
- 用户指南(安卡拉区域)
- API参考(安卡拉区域)
- 通用参考
链接复制成功!
查询云硬盘列表
功能介绍
查询云硬盘列表。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/volumes
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID。 获取方法请参见"获取项目ID"。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
marker |
否 |
String |
分页查询的起始资源id,取值为上一页最后一条查询记录的资源id。 |
name |
否 |
String |
云硬盘名称。最大支持64个字符。 |
limit |
否 |
Integer |
返回结果个数限制。 最小值1,最大值1000,默认为1000。返回的结果中记录数不超过limit值。 当租户所有的云硬盘数量大于50个时,为了提升您的查询效率,建议查询的时候使用limit参数,并且参数值最大设置为50。查询示例: GET /v2/xxx/volumes?limit=50,表示查询第1~50个云硬盘。GET /v2/xxx/volumes?offset=50&limit=50,表示查询第51~100个云硬盘。 |
sort_dir |
否 |
String |
返回结果按照降序或升序排列,默认为“desc”。 降序:desc 升序:asc |
sort_key |
否 |
String |
返回结果按该关键字排序,支持id,status,size,created_at等关键字,默认为“created_at”。 |
offset |
否 |
Integer |
偏移量 偏移量为一个大于0小于磁盘总个数的整数,表示查询该偏移量后面的所有的云硬盘。 |
status |
否 |
String |
云硬盘状态,具体请参见云硬盘状态。 |
metadata |
否 |
String |
云硬盘元数据。 |
availability_zone |
否 |
String |
AZ信息。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
volumes |
Array of VolumeBody objects |
查询请求返回的云硬盘列表。 |
volumes_links |
Array of Link objects |
云硬盘列表查询位置标记。如果本次查询只返回部分列表信息时,会返回查询到的当前云硬盘mark标记的url,可以继续使用这个url查询剩余列表信息。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
云硬盘ID。 |
links |
Array of Link objects |
云硬盘URI自描述信息。 |
name |
String |
云硬盘名称。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error |
Error object |
出现错误时,返回的错误信息。 |
请求示例
GET https://{endpoint}/v2/{project_id}/volumes
响应示例
状态码: 200
OK
{ "volumes" : [ { "id" : "6b604cef-9bd8-4f5a-ae56-45839e6e1f0a", "links" : [ { "href" : "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/6b604cef-9bd8-4f5a-ae56-45839e6e1f0a", "rel" : "self" }, { "href" : "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/6b604cef-9bd8-4f5a-ae56-45839e6e1f0a", "rel" : "bookmark" } ], "name" : "zjb_u25_test" }, { "id" : "2bce4552-9a7d-48fa-8484-abbbf64b206e", "links" : [ { "href" : "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/2bce4552-9a7d-48fa-8484-abbbf64b206e", "rel" : "self" }, { "href" : "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/2bce4552-9a7d-48fa-8484-abbbf64b206e", "rel" : "bookmark" } ], "name" : "zjb_u25_test" }, { "id" : "3f1b98ec-a8b5-4e92-a727-88def62d5ad3", "links" : [ { "href" : "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/3f1b98ec-a8b5-4e92-a727-88def62d5ad3", "rel" : "self" }, { "href" : "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/3f1b98ec-a8b5-4e92-a727-88def62d5ad3", "rel" : "bookmark" } ], "name" : "zjb_u25_test" } ], "volumes_links" : [ { "href" : "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes?limit=3&marker=3f1b98ec-a8b5-4e92-a727-88def62d5ad3", "rel" : "next" } ] }
状态码: 400
Bad Request
{ "error" : { "message" : "XXXX", "code" : "XXX" } }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
错误码
请参见错误码。