云硬盘修改云硬盘属性-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： cbs.tencentcloudapi.com 。

只支持修改弹性云盘的项目ID。随云主机创建的云硬盘项目ID与云主机联动。可以通过DescribeDisks接口查询，见输出参数中Portable字段解释。
“云硬盘名称”仅为方便用户自己管理之用，腾讯云并不以此名称作为提交工单或是进行云盘管理操作的依据。
支持批量操作，如果传入多个云盘ID，则所有云盘修改为同一属性。如果存在不允许操作的云盘，则操作不执行，以特定错误码返回。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ModifyDiskAttributes。
Version	是	String	公共参数，本接口取值：2017-03-12。
Region	是	String	公共参数，详见产品支持的地域列表。
DiskIds.N	是	Array of String	一个或多个待操作的云硬盘ID。如果传入多个云盘ID，仅支持所有云盘修改为同一属性。示例值：["disk-l7mxexxc"]
DiskName	否	String	新的云硬盘名称。示例值：DataDisk-Production-01
Portable	否	Boolean	是否为弹性云盘，FALSE表示非弹性云盘，TRUE表示弹性云盘。仅支持非弹性云盘修改为弹性云盘。示例值：TRUE
ProjectId	否	Integer	新的云硬盘项目ID，只支持修改弹性云盘的项目ID。通过DescribeProject接口查询可用项目及其ID。示例值：0
DeleteWithInstance	否	Boolean	成功挂载到云主机后该云硬盘是否随云主机销毁，TRUE表示随云主机销毁，FALSE表示不随云主机销毁。仅支持按量计费云硬盘数据盘。示例值：FALSE
DiskType	否	String	变更云盘类型时，可传入该参数，表示变更的目标类型，取值范围： CLOUD_PREMIUM：表示高性能云硬盘 CLOUD_SSD：表示SSD云硬盘。当前不支持批量变更类型，即传入DiskType时，DiskIds仅支持传入一块云盘；变更云盘类型时不支持同时变更其他属性。示例值：CLOUD_SSD
BurstPerformanceOperation	否	String	开启/关闭云盘性能突发功能示例值：CREATE

3. 输出参数

参数名称	类型	描述
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改云硬盘名称

修改指定云硬盘名称为test_data_disk

输入示例

POST / HTTP/1.1
Host: cbs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyDiskAttributes
<公共请求参数>

{
    "DiskName": "test_data_disk",
    "DiskIds": [
        "disk-fyctkqsf"
    ]
}

输出示例

{
    "Response": {
        "RequestId": "bf84fb00-6949-c0f6-aea8-5a1f806401c2"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InternalError.ComponentError	依赖组件请求失败，请联系客服人员解决。
InvalidAccount.InsufficientBalance	账户余额不足。
InvalidDisk.NotSupported	云硬盘不支持该操作。
InvalidDiskId.NotFound	输入的`DiskId`不存在。
InvalidInstanceId.NotFound	输入实例的`InstanceId`不存在。
InvalidParameter.DiskConfigNotSupported	当前地域不支持当前配置的云盘。
InvalidParameterValue	参数取值错误。
InvalidParameterValue.LimitExceeded	参数值数量超过限制。
MissingParameter	缺少参数错误。
ResourceInUse.DiskMigrating	云硬盘当前已在迁移中，请稍后重试。
ResourceInsufficient	资源不足。
ResourceNotFound.NotFound	资源不存在。
ResourceUnavailable.NotSupported	资源不支持此操作。
TradeDealConflict	订单冲突。

修改云硬盘属性

本页目录：