文档中心 云硬盘 API 文档 云硬盘相关接口 修改云硬盘属性

修改云硬盘属性

最近更新时间：2019-07-24 15:06:52

查看pdf

在这篇文章中：

1. 接口描述

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

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

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

注意：本接口支持金融区地域。由于金融区和非金融区是隔离不互通的，因此当公共参数 Region 为金融区地域（例如 ap-shanghai-fsi）时，需要同时指定带金融区地域的域名，最好和 Region 的地域保持一致，例如：cbs.ap-shanghai-fsi.tencentcloudapi.com。

2. 输入参数

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

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

    3. 输出参数

    参数名称 类型 描述
    RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 修改云硬盘名称

    输入示例

    https://cbs.tencentcloudapi.com/?Action=ModifyDiskAttributes
&DiskIds.0=disk-fyctkqsf
&DiskName=test_data_disk
&<公共请求参数>

    输出示例

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

    示例2 修改云盘类型

    将一块弹性数据盘，付费模式为预付费，从普通云盘升级为高性能云盘，云盘大小 100G，当前未挂载。

    输入示例

    https://cbs.tencentcloudapi.com/?Action=ModifyDiskAttributes
&DiskIds.0=disk-hdz4c824
&DiskType=CLOUD_PREMIUM
&<公共请求参数>

    输出示例

    {
  "Response": {
    "RequestId": "d010c751-3edb-4388-878c-1de0891aa1fd"
  }
}

    5. 开发者资源

    API Explorer

    该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力，能显著降低使用云 API 的难度，推荐使用。

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InternalError.ComponentError 依赖组件请求失败，请联系客服人员解决。
    InvalidDisk.NotSupported 云硬盘不支持该操作。
    InvalidDiskId.NotFound 输入的DiskId不存在。
    InvalidParameterValue 无效参数值。参数值格式错误或者参数值不被支持等。
    MissingParameter 参数缺失。请求没有带必选参数。

    云硬盘 相关文档