查询云硬盘列表(废弃)
URI
- URI格式
- 参数说明
参数
是否必选
描述
project_id
是
项目ID。
获取方法请参见获取项目ID。
- Request filter参数
参数
参数类型
是否必选
描述
marker
String
否
分页查询的起始资源id,取值为上一页最后一条查询记录的资源id。
name
String
否
云硬盘名称。最大支持255个字节。
status
String
否
云硬盘状态,具体请参见云硬盘状态。
limit
Integer
否
返回结果个数限制。
最小值1,最大值1000,默认为1000。返回的结果中记录数不超过limit值。
availability_zone
String
否
AZ信息。
sort_key
String
否
返回结果按该关键字排序,支持id,status,size,created_at等关键字,默认为“created_at”。
sort_dir
String
否
返回结果按照降序或升序排列,默认为“desc”。- 降序:desc
- 升序:asc
请求消息
- 请求样例:
GET https://{endpoint}/v2/{project_id}/cloudvolumes?status=available
响应消息
- 响应参数
参数
参数类型
描述
volumes
Array of objects
查询请求返回的云硬盘列表,请参见•volumes参数说明。
error
Object
出现错误时,返回的错误信息,具体请参见•error参数说明。
- volumes参数说明
参数
参数类型
描述
id
String
云硬盘的ID。
links
Array of objects
云硬盘uri自描述信息,请参见•links参数说明。
name
String
云硬盘的名称。最大支持255个字节。
- links参数说明
参数
参数类型
描述
href
String
对应的快捷链接。
rel
String
快捷链接标记名称。
- error参数说明
参数
参数类型
描述
message
String
出现错误时,返回的错误消息。
code
String
出现错误时,返回的错误码。
错误码和其对应的含义请参考错误码。
- 响应样例
{ "volumes": [ { "id": "e6cf4401-15f6-44bd-ae2b-cff4dc9523e6", "links": [ { "href": "https://volume.az0.dc1.domainname.com/v2/cd631140887d4b6e9c786b67a6dd4c02/volumes/e6cf4401-15f6-44bd-ae2b-cff4dc9523e6", "rel": "self" }, { "href": "https://volume.az0.dc1.domainname.com/cd631140887d4b6e9c786b67a6dd4c02/volumes/e6cf4401-15f6-44bd-ae2b-cff4dc9523e6", "rel": "bookmark" } ], "name": "hallo5" }, { "id": "4c5e8203-f70e-4717-90cd-4a8f636888d1", "links": [ { "href": "https://volume.az0.dc1.domainname.com/v2/cd631140887d4b6e9c786b67a6dd4c02/volumes/4c5e8203-f70e-4717-90cd-4a8f636888d1", "rel": "self" }, { "href": "https://volume.az0.dc1.domainname.com/cd631140887d4b6e9c786b67a6dd4c02/volumes/4c5e8203-f70e-4717-90cd-4a8f636888d1", "rel": "bookmark" } ], "name": "hallo4" } ] }
或
{ "error": { "message": "XXXX", "code": "XXX" } }
错误码
请参考错误码。