帮助文档 Logo
平台使用
阿里云
百度云
移动云
智算服务
教育生态
登录 →
帮助文档 Logo
平台使用 阿里云 百度云 移动云 智算服务 教育生态
登录
  1. 首页
  2. 阿里云
  3. 云服务器 ECS
  4. 开发参考
  5. API参考(ECS)
  6. API目录
  7. 块存储
  8. ModifyDiskAttribute - 修改块存储属性

ModifyDiskAttribute - 修改块存储属性

  • 块存储
  • 发布于 2025-04-01
  • 0 次阅读
文档编辑
文档编辑

修改一个或多个块存储设备的名称、描述、是否随实例释放、是否随磁盘删除其自动快照、是否启用自动快照策略、是否开启性能突发功能等。

接口说明

您可以调用DiskId参数修改一个块存储设备的名称、描述、是否随实例释放等属性,调用DiskIds.N参数批量修改多个块存储设备的属性。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
DiskIdstring否

待修改属性的磁盘 ID。

说明 DiskId和DiskIds.N两个参数不能同时被调用,请您根据需求任选其一传值。
d-bp1famypsnar20bv****
DiskNamestring否

磁盘名称。长度为 2~128 个字符,支持 Unicode 中 letter 分类下的字符(其中包括英文、中文和数字等)。可以包含半角冒号(:)、下划线(_)、半角句号(.)或者短划线(-)。

MyDiskName
Descriptionstring否

磁盘描述。 长度为 2~256 个英文或中文字符,不能以http://和https://开头。

TestDescription
DeleteWithInstanceboolean否

磁盘是否随实例释放。默认值:无,无表示不改变当前的值。

开启多重挂载特性的云盘,不支持设置该参数。

在下列两种情况下,将参数DeleteWithInstance设置成false时会报错。

  • 磁盘的种类(category)为本地盘(ephemeral)时。
  • 磁盘的种类(category)为普通云盘(cloud),且不可以卸载(Portable=false)时。

警告 如果您设置了不随实例释放(DeleteWithInstance=false),一旦磁盘挂载的 ECS 实例被安全锁定且 OperationLocks 中标记了"LockReason" : "security"的锁定状态,释放实例时会忽略磁盘的 DeleteWithInstance 属性而被同时释放。

false
DeleteAutoSnapshotboolean否

删除磁盘时,是否同时删除其自动快照。取值范围:

  • true:启用。

  • false:关闭。

默认值:无,无表示不改变当前的值。

false
EnableAutoSnapshotboolean否

磁盘是否启用自动快照策略功能。取值范围:

  • true:启用。
  • false:关闭。

默认值:无,表示不改变当前的值。

说明 该参数已弃用。创建后的云盘默认启用自动快照策略功能,您只需要为云盘绑定自动快照策略即可正常使用。
true
RegionIdstring是

地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

cn-hangzhou
DiskIdsarray否

待修改多个磁盘的 ID 列表。N 的取值范围为 0 ~ 100。

说明 DiskId和DiskIds.N两个参数不能同时被调用,请您根据需求任选其一传值。
string否

待修改多个磁盘的 ID。N 的取值范围为 0 ~ 100。

说明 DiskId和DiskIds.N两个参数不能同时被调用,请您根据需求任选其一传值。
d-bp1famypsnar20bv****
BurstingEnabledboolean否

针对支持 Burst(性能突发)的磁盘是否开启此功能,取值范围:

  • true:是。
  • false:否。
说明 对于不支持 Burst 功能的磁盘,传入任意值将会报错。
false

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

错误码

HTTP status code错误码错误信息描述
400InvalidDiskName.MalformedThe specified disk name is wrongly formed.磁盘名称格式不正确。长度为2-128个字符,以英文字母或中文开头,可包含数字,点号(.),下划线(_)或连字符(-)。 不能以http://和https://开头。
400NoAttributeToModifyNo attribute to be modified in this request.没有任何属性被修改。
400IncompleteParamterSome fields can not be null in this request.请求中缺失参数。
400InvalidRegionId.MalFormedThe specified RegionId is not valid.指定的地域不存在,请检查该参数是否正确。
400MissingParameter.DiskIdOrDiskIdsSpecified parameter DiskId or DiskIds is missing.-
400ParameterConflict.DiskIdAndDiskIdsSpecified parameter DiskId and DiskIds conflict, only one can be chosen.-
400BurstingEnabledForDiskCategoryUnsupportedThe specified disk category does not support bursting enabled.指定的磁盘类型不支持开启性能突发特性。
400BurstingEnabledForMultiAttachDiskUnsupportedThe multi attach disk does not support bursting enabled.多重挂载磁盘不支持开启性能突发特性。
400BurstingEnabledForModifyingDiskUnsupportedThe modifying disk does not support bursting enabled.变配中的磁盘不允许修改burst特性。
400InvalidBurstingEnabled.DiskSizeTooSmallThe disk size must be greater than 3 GiB to enable burst.磁盘大小超过3GiB时才能开启性能突发。
403QuotaExceed.SnapshotThe snapshot quota exceeds.快照额度超过限制,若要存储新快照,在不影响业务的情况下,请您删除已有的老快照。
403DiskNotPortableThe specified disk is not a portable disk.指定的磁盘不是可卸载的磁盘,Portable 为 false 的磁盘无法卸载。
403IncorrectDiskStatusThe operation is not supported in this status.当前的磁盘不支持此操作,请您确认磁盘处于正常使用状态,是否欠费。
403UserNotInTheWhiteListThe user is not in disk white list.您不在磁盘白名单中,请加入白名单后重试。
403DeleteWithInstance.ConflictThe specified image is from the image market, you cannot set DeleteWithInstance attribute to false.指定的镜像来自镜像市场,不支持取消随实例释放。
403DeleteWithInstance.ConflictMulti attach disk cannot be set to DeleteWithInstance attribute.开启多重挂载特性的云盘不支持设置 DeleteWithInstance。
404InvalidDiskId.NotFoundThe specified disk does not exist.指定的磁盘不存在。请您检查磁盘 ID 是否正确。
404InvalidDescription.MalformedThe specified description is wrongly formed.指定的资源描述格式不合法。长度为 2-256 个字符,不能以 http:// 和 https:// 开头。
404InvalidInstanceId.NotFoundSpecified attached instance does not exist.指定的实例不存在,请您检查实例 ID 是否正确。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2025-01-17OpenAPI 错误码发生变更查看变更详情
2024-12-04OpenAPI 描述信息更新、OpenAPI 错误码发生变更查看变更详情
2023-08-25OpenAPI 错误码发生变更查看变更详情
相关文章

AttachDisk - 为实例挂载磁盘 2025-04-01 11:58

为一台ECS实例挂载一块按数据盘或系统盘。 接口说明

CreateDisk - 创建数据盘 2025-04-01 11:58

创建一块按量付费或包年包月的数据盘。 接口说明

DeleteDisk - 释放一块按量付费数据盘 2025-04-01 11:58

释放一块按量付费数据盘。磁盘类型包括普通云盘、高效云盘、SSD云盘和ESSD云盘。

DescribeDiskDefaultKMSKeyId - 查询块存储账号级默认加密使用的密钥 2025-04-01 11:58

查询块存储账号级默认加密使用的密钥。

DescribeDiskEncryptionByDefaultStatus - 查询块存储账号级默认加密的服务状态 2025-04-01 11:58

查询指定地域块存储账号级默认加密的服务状态。

DescribeDisks - 查询块存储 2025-04-01 11:58

查询一块或多块已创建的块存储(包括云盘、本地盘以及弹性临时盘)信息。 接口说

目录
Copyright © 2025 your company All Rights Reserved. Powered by 博智数字服务平台.
闽ICP备08105208号-1