调用CreateReplicationJob为迁移源创建一个迁移任务。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
smc:CreateReplicationJob | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 迁移源要迁入的目标阿里云地域ID。 例如,您需要迁移源服务器至杭州,则相应的阿里云地域ID为 | cn-hangzhou |
ClientToken | string | 否 | 保证请求幂等性。您可以从客户端生成一个不超过64个ASCII字符的参数值,并将值赋予ClientToken,保证重试请求的幂等性。更多详情,请参见如何保证幂等性。 | 123e4567-e89b-12d3-a456-426655440000 |
Name | string | 否 | 迁移任务名。迁移任务的名称需满足以下要求:
| testMigrationTaskName |
Description | string | 否 | 迁移任务描述。 长度应为2~128个英文或中文字符,必须以大小字母或中文开头,不能以 | This_is_a_migration_task |
SourceId | string | 是 | 迁移源ID。 | s-bp1e2fsl57knvuug**** |
TargetType | string | 否 | 迁移任务交付的目标类型。取值范围:
| Image |
ScheduledStartTime | string | 否 | 迁移任务的执行时间。该参数值的设置需满足以下要求:
说明
如果该参数值为空,则SMC不会启动迁移任务,需要您调用StartReplicationJob启动任务。
| 2019-06-04T13:35:00Z |
ValidTime | string | 否 | 迁移任务的过期时间。取值范围:迁移任务创建时间+7天~迁移任务创建时间+90天。
默认值:迁移任务创建时间+30天(表示迁移任务的默认有效期为创建后30天)。 | 2019-06-04T13:35:00Z |
ImageName | string | 否 | 迁移任务交付的目标阿里云镜像名称。目标镜像的名称需满足以下要求:
说明
迁移任务运行过程中,若当前地域已经存在相同名称的镜像,则系统默认给镜像名称添加迁移任务ID(JobId)作为后缀,如:ImageName_j-2zexxxxxxxxxxxxx。
| testAliCloudImageName |
InstanceId | string | 否 | 目标实例ID。 | i-bp1f1dvfto1sigz5**** |
SystemDiskSize | integer | 否 | 目标阿里云服务器ECS的系统盘大小,单位为GiB。取值范围:20~2048。 说明
该参数取值需要大于迁移源系统盘实际占用大小,例如,源系统盘大小为500 GiB,实际占用100 GiB,则该参数取值需大于100 GiB。
| 80 |
VpcId | string | 否 | 已配置高速通道服务或者VPN网关的VPC ID。 | vpc-bp1vwnn14rqpyiczj**** |
VSwitchId | string | 否 | 指定VPC下的虚拟交换机ID。 使用VPC内网迁移时,该参数为必填参数。 | vsw-bp1ddbrxdlrcbim46**** |
ReplicationParameters | string | 否 | 复制驱动器的参数信息。参数信息为JSON格式键值对,键值固定。最大长度:2048个字符。 复制驱动器是指,复制源服务器数据到中转实例时所使用的工具。不同复制驱动器支持参数可能不同。复制驱动器SMT目前支持以下参数:
复制驱动器的取值,请参见DescribeSourceServers的返回参数 | {"bandwidth_limit":0,"compress_level":1,"checksum":true} |
NetMode | integer | 否 | 数据传输网络模式。取值范围:
默认值:0。 | 0 |
RunOnce | boolean | 否 | 创建一次性迁移任务还是增量迁移任务。取值范围:
说明
该参数值只能在创建迁移任务时指定。参数值一经指定,则无法更改。
| true |
Frequency | integer | 否 | 增量迁移任务运行的时间间隔,单位:小时。取值范围:1~168。
默认值:无。 | 12 |
MaxNumberOfImageToKeep | integer | 否 | 增量迁移任务默认保留的最大镜像数。取值范围:1~10。
默认值:无。 | 10 |
InstanceType | string | 否 | 中转实例的实例规格。 调用DescribeInstanceTypes可查询云服务器ECS提供的实例规格。
| ecs.c6.large |
LaunchTemplateId | string | 否 | 实例启动模板ID。 | lt-bp16jovvln1cgaaq**** |
LaunchTemplateVersion | string | 否 | 实例启动模板的版本。 | 1 |
InstanceRamRole | string | 否 | 实例RAM角色名称。 | SMCAdmin |
ContainerNamespace | string | 否 | Docker的命名空间。关于Docker容器镜像详情请参见容器镜像服务。 | testNamespace |
ContainerRepository | string | 否 | Docker的镜像仓库。关于Docker容器镜像详情请参见容器镜像服务。 | testRepository |
ContainerTag | string | 否 | Docker的镜像标签。关于Docker容器镜像详情请参见容器镜像服务。 | CentOS:v1 |
LicenseType | string | 否 | BYOL | |
DataDisk | object [] | 否 | 数据盘信息列表。 | |
Index | integer | 否 | 目标阿里云服务器ECS的数据盘顺序。初始值为1。取值范围:1~16 说明
您只能为迁移源中存在的数据盘创建目标数据盘。
| 1 |
Part | object [] | 否 | 分区列表。 | |
SizeBytes | long | 否 | 目标数据盘N分区N的大小。单位:Byte。默认为源数据盘分区大小。 说明
| 254803968 |
Block | boolean | 否 | 数据盘N分区N是否开启块复制。取值范围:
默认值:true。 | true |
Device | string | 否 | 目标数据盘N分区N对应的分区设备标识。N的实际取值请参考迁移源的分区设备标识。 说明
当 DataDisk.N.Part.N.SizeBytes 不为空时,该参数也不能为空。
| 0_1 |
Size | integer | 否 | 目标阿里云服务器ECS的数据盘大小,单位为GiB。取值范围:20~32768。 说明
该参数取值需要大于迁移源数据盘实际占用大小。例如,源数据盘大小为500 GiB,实际占用100 GiB,则该参数取值需大于100 GiB。
| 100 |
Tag | object [] | 否 | 标签列表。 | |
Key | string | 否 | 迁移任务的标签键。N的取值范围:1~20 一旦传入该值,则不允许为空字符串。最多支持128个字符,不能以 | TestKey |
Value | string | 否 | 迁移任务的标签值。N的取值范围:1~20。 一旦传入该值,可以为空字符串。最多支持128个字符,不能以 | TestValue |
SystemDiskPart | object [] | 否 | 系统盘分区信息。 | |
SizeBytes | long | 否 | 系统盘分区N大小。单位:Byte。默认为源系统盘分区大小。 说明
| 254803968 |
Block | boolean | 否 | 系统盘分区N是否开启块复制。取值范围:
默认值:true。 | true |
Device | string | 否 | 目标系统盘分区N设备标识。N的实际取值请参考迁移源的分区设备标识。 说明
当 SystemDiskPart.N.SizeBytes 不为空时,该参数也不能为空。
| 0_1 |
JobType | integer | 否 | 迁移任务的类型。取值范围:
| 0 |
ResourceGroupId | string | 否 | 资源组ID。 | rg-acfmw3ty5y7**** |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "C8B26B44-0189-443E-9816-D951F59623A9",
"JobId": "j-bp17bclvg344jlyt****"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | SourceServerState.Invalid | The specified source server status is invalid. | 无效的迁移源状态。 |
400 | ReplicationJobDataDiskIndex.Invalid | The specified replication job contains data disk index not found in source server. | 迁移任务包含的数据盘索引在迁移源中不存在。 |
400 | VSwitchIdVpcId.Mismatch | The specified VSwitchId and VpcId does not match. | 指定的VSwitchId和VpcId不匹配。 |
400 | InvalidSecurityGroupId.IncorrectNetworkType | 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. | 指定的安全组和交换机不在一个专有网络。 |
400 | QuotaExceeded.ReplicationJob | 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. | 迁移任务名称已存在,请修改迁移任务名称。 |
500 | InternalError | An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket. | 内部错误,请重试。如果多次尝试失败,请提交工单。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|