使用ModifyDiskAttribute修改云盘属性-云服务器 ECS-阿里云-云服务器 ECS(ECS)-阿里云帮助中心

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

接口说明

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ecs:ModifyDiskAttribute

update

*Disk

acs:ecs:{#regionId}:{#accountId}:disk/{#diskId}

无

请求参数

名称	类型	必填	描述	示例值
DiskId	string	否	待修改属性的磁盘 ID。说明 `DiskId`和`DiskIds.N`两个参数不能同时被调用，请您根据需求任选其一传值。	d-bp1famypsnar20bv****
DiskName	string	否	磁盘名称。长度为 2~128 个字符，支持 Unicode 中 letter 分类下的字符（其中包括英文、中文和数字等）。可以包含半角冒号（:）、下划线（_）、半角句号（.）或者短划线（-）。	MyDiskName
Description	string	否	磁盘描述。长度为 2~256 个英文或中文字符，不能以`http://`和`https://`开头。	TestDescription
DeleteWithInstance	boolean	否	磁盘是否随实例释放。默认值：无，无表示不改变当前的值。开启多重挂载特性的云盘，不支持设置该参数。在下列两种情况下，将参数`DeleteWithInstance`设置成`false`时会报错。磁盘的种类（category）为本地盘（ephemeral）时。磁盘的种类（category）为普通云盘（cloud），且不可以卸载（Portable=false）时。警告如果您设置了不随实例释放（DeleteWithInstance=false），一旦磁盘挂载的 ECS 实例被安全锁定且 OperationLocks 中标记了"LockReason" : "security"的锁定状态，释放实例时会忽略磁盘的 DeleteWithInstance 属性而被同时释放。	false
DeleteAutoSnapshot	boolean	否	删除磁盘时，是否同时删除其自动快照。取值范围： true：启用。 false：关闭。默认值：无，无表示不改变当前的值。	false
EnableAutoSnapshot	boolean	否	磁盘是否启用自动快照策略功能。取值范围： true：启用。 false：关闭。默认值：无，表示不改变当前的值。说明该参数已弃用。创建后的云盘默认启用自动快照策略功能，您只需要为云盘绑定自动快照策略即可正常使用。	true
RegionId	string	否	地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。	cn-hangzhou
DiskIds	array	否	待修改多个磁盘的 ID 列表。N 的取值范围为 0 ~ 100。说明 `DiskId`和`DiskIds.N`两个参数不能同时被调用，请您根据需求任选其一传值。	d-bp1famypsnar20bv****
	string	否	待修改多个磁盘的 ID。N 的取值范围为 0 ~ 100。说明 `DiskId`和`DiskIds.N`两个参数不能同时被调用，请您根据需求任选其一传值。	d-bp1famypsnar20bv****
BurstingEnabled	boolean	否	针对支持 Burst（性能突发）的磁盘是否开启此功能，取值范围： true：是。 false：否。说明对于不支持 Burst 功能的磁盘，传入任意值将会报错。	false

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

示例

正常返回示例

JSON格式

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

异常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidDiskName.Malformed	The specified disk name is wrongly formed.	磁盘名称格式不正确。长度为2-128个字符，以英文字母或中文开头，可包含数字，点号（.），下划线（_）或连字符（-）。不能以http://和https://开头。
400	NoAttributeToModify	No attribute to be modified in this request.
400	IncompleteParamter	Some fields can not be null in this request.	请求中缺失参数。
400	InvalidRegionId.MalFormed	The specified RegionId is not valid.
400	MissingParameter.DiskIdOrDiskIds	Specified parameter DiskId or DiskIds is missing.
400	ParameterConflict.DiskIdAndDiskIds	Specified parameter DiskId and DiskIds conflict, only one can be chosen.
400	BurstingEnabledForDiskCategoryUnsupported	The specified disk category does not support bursting enabled.	指定的磁盘类型不支持开启性能突发特性。
400	BurstingEnabledForMultiAttachDiskUnsupported	The multi attach disk does not support bursting enabled.	多重挂载磁盘不支持开启性能突发特性。
400	BurstingEnabledForModifyingDiskUnsupported	The modifying disk does not support bursting enabled.	变配中的磁盘不允许修改burst特性。
400	InvalidBurstingEnabled.DiskSizeTooSmall	The disk size must be greater than 3 GiB to enable burst.	磁盘大小超过3GiB时才能开启性能突发。
403	QuotaExceed.Snapshot	The snapshot quota exceeds.
403	DiskNotPortable	The specified disk is not a portable disk.
403	IncorrectDiskStatus	The operation is not supported in this status.	当前的磁盘不支持此操作，请您确认磁盘处于正常使用状态，是否欠费。
403	UserNotInTheWhiteList	The user is not in disk white list.	您不在磁盘白名单中，请加入白名单后重试。
403	DeleteWithInstance.Conflict	The specified image is from the image market, you cannot set DeleteWithInstance attribute to false.	指定的镜像来自镜像市场，不支持取消随实例释放。
404	InvalidDiskId.NotFound	The specified disk does not exist.	指定的磁盘不存在。请您检查磁盘 ID 是否正确。
404	InvalidDescription.Malformed	The specified description is wrongly formed.
404	InvalidInstanceId.NotFound	Specified attached instance does not exist.	指定的实例不存在，请您检查实例 ID 是否正确。

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

变更历史

更多信息，参考变更详情。