租户端 存储 云硬盘（CBS） 云硬盘相关接口 ModifyDiskAttributes

ModifyDiskAttributes

最近更新时间: 2024-12-21 13:01:31

1. 接口描述

接口请求域名： cbs.api3.gsesgpucloud.com。

本接口（ModifyDiskAttributes）用于修改云硬盘属性。

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

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

接口更新时间：2024-07-15 23:03:10。

接口只验签名不鉴权。

2. 输入参数

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

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

    3. 输出参数

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

    4. 错误码

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

    错误码 描述
    InvalidDiskId.NotFound 输入的DiskId不存在。
    InvalidDisk.NotSupported 云硬盘不支持该操作。
    InvalidParameterValue 无效参数值。参数值格式错误或者参数值不被支持等。
    MissingParameter 参数缺失。请求没有带必选参数。