查询磁盘列表
更新时间：2024-07-02
该接口用于查询所有的磁盘列表信息，不包含本地磁盘。
请求结构
GET /v{version}/volume?marker={marker}&maxKeys={maxKeys}&instanceId={instanceId} HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| marker | String | 否 | Query参数 | 批量获取列表的查询的起始位置，是一个由系统生成的字符串 |
| maxKeys | int | 否 | Query参数 | 每页包含的最大数量，最大数量通常不超过1000。缺省值为1000 |
| instanceId | String | 否 | Query参数 | 实例id，可查询实例挂载的磁盘列表（包含系统盘）。如需查询用户创建的所有磁盘信息，不填写此参数。 |
| zoneName | String | 否 | Query参数 | 可用区信息 |
| clusterId | String | 否 | Query参数 | CDS专属集群ID |
| chargeFilter | String | 否 | Query参数 | CDS计费类型,取值postpay/prepay |
| usageFilter | String | 否 | Query参数 | CDS磁盘类型，取值system/data |
| name | String | 否 | Query参数 | CDS磁盘名称 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| marker | String | 标记查询的起始位置 |
| isTruncated | boolean | true表示后面还有数据，false表示已经是最后一页。 |
| nextMarker | String | 获取下一页所需要传递的marker值。当isTruncated为false时，该域不出现。 |
| maxKeys | int | 每页包含的最大数量 |
| volumes | List<VolumeModel> | 返回的磁盘信息列表 |
请求示例
GET /v2/volume?marker=v-8CM91d5U&maxKeys=1&instanceId=i-j7lMWiyX HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de返回示例
HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Cache-Control: no-cache
Content-Length: 17527
Content-Type: application/json;charset=UTF-8
Date: Wed, 08 Jul 2015 03:38:06 GMT
Server: BWS
{
"nextMarker": "v-w7RKfn2d",
"marker": "v-8CM91d5U",
"maxKeys": 1,
"volumes": [
{
"id": "v-8CM91d5U",
"createTime": "2015-06-25T12:48:29Z",
"expireTime": null,
"name": "instance-0svq10tr-1",
"diskSizeInGB": 20,
"status": "InUse",
"type": "Cds",
"storageType": "hp1",
"desc": "",
"paymentTiming": "Postpaid",
"attachments": [
{
"volumeId": "v-3zmCcxbR",
"instanceId": "i-j7lMWiyX",
"device": "/dev/vdb"
"serial":"062b3f5d-b8a5-4c29-9"
}
],
"zoneName": "cn-bj-a"
}
],
"truncated": true
}