1. 接口描述
本接口(ModifyCbsStorageAttributes)用于修改指定云硬盘的名称或项目 ID。
接口调用域名:cbs.api.qcloud.com
使用限制:
- 只支持修改弹性云盘的项目 ID;随云服务器创建的云硬盘项目 ID 与云服务器联动。云硬盘类型可以通过DescribeCbsStorages(查询云硬盘信息)接口查询,见输出参数中
portable
字段解释。
2. 输入参数
以下请求参数列表仅列出了接口请求参数,其它参数见公共请求参数页面。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
storageId | 是 | String | 云硬盘 ID, 通过DescribeCbsStorages(查询云硬盘信息)接口查询 |
storageName | 否 | String | 新的云硬盘名称 |
projectId | 否 | Int | 新的弹性云盘项目 ID,只能修改弹性云盘的项目 ID。通过 DescribeProject(查询项目列表)接口查询可用项目及其 ID |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
code | Int | 公共错误码,0表示成功,其他值表示失败。详见错误码页面 |
message | String | 错误信息,详见错误码页面 |
4. 错误码表
以下错误码表仅列出了该接口的业务逻辑错误码,更多公共错误码详见云硬盘错误码。
错误代码 | 英文描述 | 错误描述 |
---|---|---|
9003 | InvalidParameter | 参数错误 |
11039 | OperationDenied.AuthFailure | 鉴权失败 |
5. 示例
输入
https://cbs.api.qcloud.com/v2/index.php? <公共请求参数> &Action=ModifyCbsStorageAttributes &storageId=disk-3clz8g94 &storageName=nihao
输出
{ "code":"0", "message":"" }