Attach a CDS disk
Updated at：2025-10-20
- This API mounts a specified disk to a designated BCC instance.
Note:
A CDS disk must be mounted to a BCC instance within the same availability zone; otherwise, a 403 error will be returned.
- Mounting is only permitted when the disk status is "Available" and the instance status is either "Running" or "Stopped." Otherwise, calling this API will result in a 409 error.
Request structure
Plain Text
1PUT /v{version}/volume/{volumeId}?{action} HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "instanceId":instanceId,
7 "deleteWithInstance":deleteWithInstance,
8 "deleteAutoSnapshot":deleteAutoSnapshot
9}Request headers
There are no special headers required beyond the common headers.
Request parameters
| Parameter name | Types | Whether required | Parameter location | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number |
| volumeId | String | Yes | URL parameter | Disk ID |
| action | String | Yes | Query | Action performed on the disk, current value: attach |
| instanceId | String | Yes | Request Body parameters | ID of the virtual machine instance to be mounted |
| deleteWithInstance | boolean | No | Request Body parameters | Delete disk with instance: default is false. Only postpaid data disks support configuring this option |
| deleteAutoSnapshot | boolean | No | Request Body parameters | Delete automatic snapshots with disk: default is false. All types of disks support configuring this option |
Response headers
No special headers are required beyond the standard ones.
Response parameters
| Parameter name | Types | Description |
|---|---|---|
| volumeAttachment | [VolumeAttachmentModel](BCC/API Reference/Appendix.md#VolumeAttachmentModel) | Information about the virtual machine to which the disk is mounted |
| warningList | Warning information generated when attaching the disk |
Error codes
| Error code | Error description | HTTP status code | Chinese explanation |
|---|---|---|---|
| Volume.InstanceStatusCannotAttach | Instance only when it is running or stopped state can mount to it. | 409 | Attaching the disk: virtual machine status is not allowed |
| Volume.DistNotAvailable | Volume status is not available, can not be attached to instance. | 409 | Disk status is unavailable |
| Volume.DiskAttachedQuotaExceededLimit | The attached disk number to an instance exceeds limit. | 413 | CDS mount quota exceeded |
Request example
Plain Text
1PUT /v2/volume/v-3zmCcxbR?attach HTTP/1.1
2Host: bcc.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
5
6{
7 "instanceId":"i-j7lMWiyX"
8}Response example
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Wed, 03 Dec 2014 06:42:19 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6
7{
8 "volumeAttachment": {
9 "volumeId": "v-3zmCcxbR",
10 "instanceId": "i-j7lMWiyX",
11 "device": "/dev/vdb"
12 "serial":"062b3f5d-b8a5-4c29-9"
13 },
14 "warningList": [
15 "warning info"
16 ]
17}