CreateCrossZoneMigrationJob - Server Migration Center - Alibaba Cloud Documentation Center

Server Migration Center (SMC) lets you migrate an Alibaba Cloud Elastic Compute Service (ECS) instance to a different zone within the same region and change its instance type, including the vCPU and memory, within the same instance family. This feature helps you meet business requirements for instance migration and specification changes. Call this operation to create a cross-zone migration job.

Operation description

For more information about the limits and effects of cross-zone migration, see Cross-zone migration.

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

smc:CreateCrossZoneMigrationJob

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the destination Alibaba Cloud region. For example, if you want to migrate a source server to the China (Hangzhou) region, the region ID is `cn-hangzhou`. You can call DescribeRegions to view the latest list of Alibaba Cloud regions.	cn-hangzhou
ClientToken	string	No	A client token to ensure the idempotence of the request. Generate a unique value for this parameter from your client. `ClientToken` can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.	123e4567-e89b-12d3-a456-426655440000
InstanceId	string	No	The ID of the ECS instance.	i-bp1ff25rzvnul6kr****
TargetVSwitchId	string	No	The ID of the destination vSwitch.	vsw-bp1mxqnssl8nafltc****
TargetZoneId	string	No	The ID of the destination zone.	cn-hangzhou-i
TargetInstanceType	string	No	The destination instance type.	ecs.g7.large
AutoPay	boolean	No	Specifies whether to enable automatic payment. Valid values: true: (Default) Enables automatic payment. Make sure that your account has a sufficient balance. false: Disables automatic payment. In this case, you must manually complete the payment. For more information, see Manually renew a subscription instance.	false
Disk	array<object>	No	The disk information.
	object	No	A disk object.
DiskId	string	No	The disk ID.	d-bp1eeplkn4j29wf7****
Category	string	No	The disk category. `cloud_essd` indicates an Enhanced SSD (ESSD).	cloud_essd
PerformanceLevel	string	No	The performance level of the ESSD. Valid values: PL0: A single disk can deliver up to 10,000 random read/write IOPS. PL1: A single disk can deliver up to 50,000 random read/write IOPS. PL2: A single disk can deliver up to 100,000 random read/write IOPS. PL3: A single disk can deliver up to 1,000,000 random read/write IOPS.	PL0
ResourceGroupId	string	No	The ID of the resource group.	rg-acfmw3ty5y7****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	A9DBD2F8-DE5A-5844-BA6F-957A996CBD78
JobId	string	The migration job ID.	j-bp17bclvg344jlyt****

Examples

Success response

JSON format

{
  "RequestId": "A9DBD2F8-DE5A-5844-BA6F-957A996CBD78",
  "JobId": "j-bp17bclvg344jlyt****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	ReplicationJobDataDiskIndex.Invalid	The specified replication job contains data disk index not found in source server.	The specified replication job contains data disk indexes that do not exist in the source server.
400	VSwitchIdVpcId.Mismatch	The specified VSwitchId and VpcId does not match.	The specified VSwitchId and VpcId does not match.
400	InvalidSecurityGroupId.IncorrectNetworkType	The network type of the specified security group does not support this action.	The network type of the specified security group does not support this action.
400	InvalidSecurityGroupId.VPCMismatch	The specified security group and the specified virtual switch are not in the same VPC.	The specified security group and the specified virtual switch are not in the same VPC.
400	QuotaExceeded.ReplicationJob	The maximum number of replication jobs is exceeded. Please submit a ticket to raise the quota.	The maximum number of replication jobs is exceeded. Please submit a ticket to raise the quota.
400	ReplicationJobName.Duplicate	The specified replication job name already exists.	The specified replication job name already exists.
400	SourceServerState.Invalid	The specified source server status: %s is invalid. This operation can only be performed in the following status: %s.	The specified source server status: %s is invalid. This operation can only be performed in the following status: %s.
500	InternalError	An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.	An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.
403	EntityNotExist.Role	The account is unauthorized. Please assign the role AliyunServiceRoleForSMC to your account.	The account does not have the operation permission, please assign the account AliyunServiceRoleForSMC role.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.