修改磁盘属性
更新时间：2025-03-13
该接口用于修改指定磁盘属性（名称、描述信息）。
请求结构
PUT /v{version}/volume/{volumeId}?{action} HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string
{
"cdsName": "volume-new-name",
"desc": "volume-new-desc",
"deleteWithInstance": deleteWithInstance,
"deleteAutoSnapshot": deleteAutoSnapshot
}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| volumeId | String | 是 | URL参数 | 待修改磁盘ID |
| action | String | 是 | Query参数 | 对磁盘的执行动作，当前取值：modify |
| cdsName | String | 否 | Request Body参数 | 磁盘新的名称，支持大小写字母、数字、中文以及-_ /.特殊字符，必须以字母开头，长度1-65。 |
| desc | String | 否 | Request Body参数 | 磁盘新的描述信息，desc与cdsName不能同时为空 |
| deleteWithInstance | boolean | 否 | Request Body参数 | 磁盘随实例删除，初始值为false，显式赋值后所有相关磁盘对应属性会被新值替换，仅后付费类型的数据盘支持配置该选项，V2 API需要在释放实例时指定cdsAttributeActive参数为true才可生效 |
| deleteAutoSnapshot | boolean | 否 | Request Body参数 | 自动快照随磁盘删除，初始值为false，显式赋值后所有相关磁盘对应属性会被新值替换，所有类型的磁盘都支持配置该选项，V2 API需要在释放实例时指定cdsAttributeActive参数为true才可生效 |
返回头域
除公共头域，无其它特殊头域。
返回参数
无特殊返回参数
错误码
| 错误码 | 错误描述 | HTTP状态码 | 中文解释 |
|---|---|---|---|
| Volume.DiskNameInvalid | Volume name is invalid. | 400 | 磁盘名称不符合规则。 |
请求示例
PUT /v2/volume/v-bSlHQpKA?modify HTTP/1.1
Host: bcc.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
{
"cdsName": "volume-new-name",
"desc": "volume-new-desc"
}返回示例
HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Wed, 03 Dec 2014 06:42:19 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS