文档首页> 云硬盘 EVS> API参考> API v2> 云硬盘> 查询云硬盘列表(废弃)
更新时间:2022-01-22 GMT+08:00
分享

查询云硬盘列表(废弃)

功能介绍

查询所有云硬盘的概要列表。该接口已废弃,请使用性能更佳的接口。

调试

您可以在API Explorer中调试该接口。

URI

GET /v2/{project_id}/cloudvolumes

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

表2 Query参数

参数

是否必选

参数类型

描述

availability_zone

String

AZ信息。

limit

Integer

返回结果个数限制。默认值为1000。

缺省值:1000

marker

String

取值为上一页数据的最后一条记录的id,返回值为该项后面的项。取值为上一页数据的最后一条记录的id,返回值为该项后面的项。

name

String

云硬盘名称。

sort_dir

String

降序或升序,分别对应desc和asc,默认为“desc”。

缺省值:desc

sort_key

String

返回结果按该关键字排序(支持id,status,size,created_at等关键字,默认为“created_at”)。

缺省值:created_at

枚举值:

  • id

  • status

  • size

  • created_at

status

String

云硬盘状态。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

Token的有效期为24小时,需要使用一个Token鉴权时,可以先缓存起来,避免频繁调用。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

volumes

Array of DiskSummary objects

查询请求返回的云硬盘列表。

表5 DiskSummary

参数

参数类型

描述

id

String

云硬盘ID。

links

Array of Link objects

云硬盘uri自描述信息。

name

String

云硬盘的名称。最大支持255个字节。

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error

Error object

出现错误时,返回的错误信息

表8 Error

参数

参数类型

描述

code

String

出现错误时,返回的错误码。 错误码和其对应的含义请参考错误码说明

message

String

错误提示信息。

请求示例

响应示例

状态码: 200

OK

{
  "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"
  } ]
}

状态码: 400

Bad Request

{
  "error" : {
    "message" : "XXXX",
    "code" : "XXX"
  }
}

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码

分享:

    相关文档

    相关产品

关闭导读