查询云磁盘列表
更新时间：2024-12-19
接口描述
本接口用于查询云磁盘列表。
请求结构
JSON
1GET /v2/volume?instanceId={instanceId}&marker={marker}&maxKeys={maxKeys}®ionId={regionId} HTTP/1.1
2Host: bec.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
|---|---|---|---|---|
| instanceId | 实例ID | query | 否 | string |
| marker | 标记查询的起始位置 | query | 否 | string |
| maxKeys | 每页包含的最大数量，1-1000，默认1000 | query | 否 | integer |
| regionId | 节点ID | query | 否 | string |
| name | CDS磁盘名称 | query | 否 | string |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 参数说明 | 类型 |
|---|---|---|
| isTruncated | true表示后面还有数据，false表示已经是最后一页 | boolean |
| marker | 标记查询的起始位置 | string |
| maxKeys | 每页包含的最大数量 | integer |
| nextMarker | 获取下一页所需要传递的marker值。当isTruncated为false时，该域不出现 | string |
| volumes | CDS列表 | List<VolumeModel> |
| attachments | 挂载设备信息列表，磁盘未挂载时该值为空 | List<VolumeAttachmentModel> |
| instanceId | 实例ID | string |
| volumeId | 磁盘ID | string |
| createTime | 创建时间 | string |
| diskSizeInGB | 磁盘大小，单位是GB | integer |
| id | 磁盘ID | string |
| name | 磁盘名称 | string |
| paymentTiming | 付费方式，付费方式，包括Postpaid(后付费) | string |
| regionId | 节点ID | string |
| status | 磁盘状态: Creating(创建中), Attaching(挂载中), Detaching(卸载中), Available(未挂载), InUse(数据盘已挂载/系统盘使用中), SnapshotProcessing(快照中), Error(异常) |
string |
| storageType | CDS磁盘存储类型，包括ssd（通用型SSD）和hdd (通用型HDD)，默认 ssd | string |
| type | Volume类型,可用值:System(系统盘),Cds(数据盘) | string |
| tags | 标签信息 | List<TagModel> |
| tagKey | 标签键 | String |
| tagValue | 标签值 | String |
错误码
请参照错误返回章节的内容。
请求示例
JSON
1GET /v2/volume HTTP/1.1
2Host: bec.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de响应示例
JSON
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3Date: Wed, 08 Jul 2015 03:28:11 GMT
4x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
5Server: BWS
6
7{
8 "marker": null,
9 "isTruncated": false,
10 "nextMarker": null,
11 "maxKeys": 1000,
12 "volumes": [
13 {
14 "id": "cds-r93lwdqpe74w",
15 "name": "data0",
16 "regionId": "cn-preonline-cm",
17 "type": "Cds",
18 "diskSizeInGB": 50,
19 "storageType": "ssd",
20 "status": "InUse",
21 "paymentTiming": "Postpaid",
22 "createTime": "2023-06-02T08:24:12Z",
23 "attachments": [
24 {
25 "volumeId": "cds-r93lwdqpe74w",
26 "instanceId": "vm-yjxodw0x-cn-preonline-cm-ltzhc"
27 }
28 ],
29 "tags": [
30 {
31 "tagKey": "tagKey",
32 "tagValue": "tagValue"
33 }
34 ]
35 },
36 {
37 "id": "cds-odaqopqhl0wz",
38 "name": "data-cds",
39 "type": "Cds",
40 "diskSizeInGB": 50,
41 "storageType": "ssd",
42 "status": "Available",
43 "paymentTiming": "Postpaid",
44 "createTime": "2023-03-20T06:48:15Z"
45 }
46 ]
47}