Query the Disk List
Last Updated:2020-07-20
- This API is used to query all disk lists, excluding local disk.
Request Structure
GET /v{version}/volume?marker={marker}&maxKeys={maxKeys}&instanceId={instanceId} HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string
Request Header Field
There are no other special header fields except the public header field.
Request Parameters
Parameter Name | Type | Required? | Parameter Position | Description |
---|---|---|---|---|
version | String | Yes | URL parameter | API version number |
marker | String | No | Query parameters | The start position of query to obtain the list by batch, which is a character string generated by the system. |
maxKeys | int | No | Query parameters | Maximum number of master instances per page, which usually does not exceed 1,000. The default value is 1,000. |
instanceId | String | No | Query parameters | Instance ID used to query the disk list mounted to the instance, including system disk. To query all disk information created by users, do not fill in this parameter. |
zoneName | String | No | Query parameters | Availability zone information |
Return Header Field
There are no other special header fields except the common header field.
Return Parameter
Parameter Name | Type | Description |
---|---|---|
marker | String | Mark the starting position of the query |
isTruncated | boolean | True means there is still data behind, and false means it is already the last page. |
nextMarker | String | Get the marker value to be passed on the next page. This field does not appear when “isTruncated” is false. |
maxKeys | int | Maximum number of master instances per page |
volumes | List<VolumeModel> | Disk information list returned |
Request Instance
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
Return Instance
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": "std1",
"desc": "",
"paymentTiming": "Postpaid",
"attachments": [
{
"volumeId": "v-3zmCcxbR",
"instanceId": "i-j7lMWiyX",
"device": "/dev/vdb"
"serial":"062b3f5d-b8a5-4c29-9"
}
],
"zoneName": "cn-bj-a"
}
],
"truncated": true
}