Modify disk properties
Updated at：2025-10-20
This API enables the modification of properties, such as the name and description, of a specified disk.
Request structure
Plain Text
1PUT /v{version}/volume/{volumeId}?{action} HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "cdsName": "volume-new-name",
7 "desc": "volume-new-desc",
8 "deleteWithInstance": deleteWithInstance,
9 "deleteAutoSnapshot": deleteAutoSnapshot
10}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 | The ID of the disk to be modified |
| action | String | Yes | Query | Action performed on the disk, current value: modify |
| cdsName | String | No | Request Body parameters | New disk name, which supports uppercase and lowercase letters, numbers, Chinese characters, and -_/special characters, starting with a letter and a length of 1-65. |
| desc | String | No | Request Body parameters | The new description information of the disk. desc and cdsName cannot be empty at the same time |
| deleteWithInstance | boolean | No | Request Body parameters | The disk is deleted with the instance. The initial value is false. After an explicit assignment, the corresponding attributes of all related disks will be replaced with the new value. Only postpaid data disks support configuring this option. In the V2 API, the cdsAttributeActive parameter needs to be specified as true when releasing the instance for it to take effect |
| deleteAutoSnapshot | boolean | No | Request Body parameters | The automatic snapshot is deleted with the disk. The initial value is false. After an explicit assignment, the corresponding attributes of all related disks will be replaced with the new value. All types of disks support configuring this option. In the V2 API, the cdsAttributeActive parameter needs to be specified as true when releasing the instance for it to take effect |
Response headers
No special headers are required beyond the standard ones.
Response parameters
There are no special response parameters
Error codes
| Error code | Error description | HTTP status code | Chinese explanation |
|---|---|---|---|
| Volume.DiskNameInvalid | Volume name is invalid. | 400 | The provided disk name does not meet the required naming rules. |
Request example
Plain Text
1PUT /v2/volume/v-bSlHQpKA?modify 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 "cdsName": "volume-new-name",
8 "desc": "volume-new-desc"
9}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