ModifyDiskDeployment - Elastic Compute Service - Alibaba Cloud Documentation Center

You can migrate cloud disks to, from, or between dedicated block storage clusters.

Operation description

Note

The dedicated block storage cluster feature is available in the China (Hangzhou), China (Shanghai), China (Beijing), China (Zhangjiakou), China (Ulanqab), China (Shenzhen), China (Heyuan), Indonesia (Jakarta), and Germany (Frankfurt) regions, as well as the China (Shenzhen) Finance region.

Before you call this operation, make sure you understand the billing methods and pricing for cloud disks and dedicated block storage clusters. You must also ensure that your dedicated block storage cluster has not expired and your account has a positive balance. For more information, see Billing for dedicated block storage and Block storage billing.

Note the following when you call this operation:

The cloud disk and the dedicated block storage cluster must be in the same availability zone.
Only pay-as-you-go cloud disks are supported. You must first convert subscription cloud disks to pay-as-you-go. For more information, see Convert the billing method of a cloud disk.
The cloud disk type must be compatible with the target dedicated block storage cluster. When migrating a disk between clusters, you can change the disk type to match the types supported by the destination cluster.
The cloud disk must be in the In use or Available state.
If the cloud disk is attached to an ECS instance, the instance must be in the Running or Stopped state. The ECS instance must not be expired.
The performance level of an ESSD cloud disk depends on its capacity. If you cannot upgrade the performance level, resize the disk and then retry the operation. For more information, see ResizeDisk and ESSD cloud disks.
You can perform a maximum of five concurrent cloud disk migration tasks per account in a single region.
During the migration, you cannot cancel the migration, create snapshots, change the configuration, resize, attach, detach, or re-initialize the disk.

Note

After a cloud disk is migrated, the destination cluster determines its billing method, type, and capabilities. The changes take effect immediately after you call the operation, and Alibaba Cloud charges you based on the new disk type and performance level. For more information, see Billing for dedicated block storage and Block storage billing.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecs:ModifyDiskDeployment

update

*Disk

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

None

Request parameters

Parameter	Type	Required	Description	Example
DiskId	string	Yes	The ID of the disk.	d-bp131n0q38u3a4zi****
DiskCategory	string	No	The new category of the disk. This parameter is valid only when you migrate a disk between different dedicated block storage clusters. The only valid value is `cloud_essd` (ESSD disk). Default value: An empty string. If you leave this parameter empty, the category of the disk remains unchanged.	cloud_essd
PerformanceLevel	string	No	The new performance level of the ESSD disk. This parameter is valid only when you migrate a disk between different dedicated block storage clusters. Valid values: `PL0`: A maximum of 10,000 random read/write IOPS per disk. `PL1`: A maximum of 50,000 random read/write IOPS per disk. Default value: An empty string. If you leave this parameter empty, the performance level of the disk remains unchanged.	PL1
StorageClusterId	string	No	The ID of the dedicated block storage cluster. To migrate the disk to a dedicated block storage cluster, specify `StorageClusterId`. To migrate the disk to a public cloud block storage cluster, leave `StorageClusterId` empty. Default value: An empty string. If you leave this parameter empty, the disk is migrated to a public cloud block storage cluster.	dbsc-cn-c4d2uea****
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: `true`: Performs a dry run. The system checks the request for required parameters, format, service limits, and inventory. The system returns an error if the check fails, or the `DryRunOperation` error code if the check succeeds. `false`: Sends the request. If the request passes the check, the system returns a 2xx HTTP status code and migrates the disk. Default value: `false`.	false

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The request ID.	D69846D9-F17F-51C0-8AC6-B4B71777****
TaskId	string	The disk migration task ID.	t-bp67acfmxazb4p****

Examples

Success response

JSON format

{
  "RequestId": "D69846D9-F17F-51C0-8AC6-B4B71777****",
  "TaskId": "t-bp67acfmxazb4p****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidDiskSpec.Malformed	The specified parameter DiskCategory or PerformanceLevel is not supported.
400	AccountInArrears	The account is in arrears.
400	InvalidStorageClusterId.DiskAlreadyInDestination	The specified disk is already in destination.
500	InternalError	The request processing has failed due to some unknown error.
403	IncorrectDiskStatus	The current disk status does not support this operation.
403	DiskCreatingSnapshot	The operation is denied due to a snapshot of the specified disk is not completed yet.
403	InvalidOperation.DiskTypeUnsupported	The type of the disk does not support this operation.
403	InvalidOperation.DiskCategoryUnsupported	The current category of the disk does not support this operation.
403	InvalidOperation.ChargeTypeUnsupported	The charge type of the disk does not support this operation.
403	InvalidPerformanceLevel.DiskSizeUnsupported	The specified parameter PerformanceLevel does not match the disk size.
403	DiskLimitExceeded	The number of migrated disks at the same time exceeds the limit.
403	OperationDenied.NoStock	The requested resource is sold out in the specified zone; try other types of resources or other regions and zones.	The requested resources are insufficient.
403	InvalidOperation.MultiAttachDisk	Multi attach disk does not support this operation.	Disks for which the multi-attach feature is enabled do not support the operation.
403	InvalidDisk.DetachedSystemDisk	The specified resource is/has a detached system disk %s , not support current operation.
403	InvalidOperation.NoPermission	You are not authorized to do this action.
403	InvalidOperation.LimitQosUnsupported	The specified disk has limited bps or iops, can not do this operation.
403	InvalidOperation.AcrossRegionsOrZonesUnsupported	Migration across regions or available zones is not supported.
403	InvalidOperation.AttachedShareDisk	Attached share disk does not support this operation.	The attached shared disk does not support this operation.
404	InvalidDiskId.NotFound	The specified disk does not exist.	The specified disk does not exist. Check whether the disk ID is correct.
404	InvalidStorageClusterId.NotFound	The specified dedicated block storage cluster does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.