调用ModifyReplicationJobAttribute修改迁移任务_服务器迁移中心(SMC)-阿里云帮助中心

调用ModifyReplicationJobAttribute修改迁移任务信息。

接口说明

修改迁移任务之前，请阅读以下注意事项：

参数Name和Description在迁移任务的整个生命周期内均可以修改。
参数Frequency和MaxNumberOfImageToKeep只能在迁移任务执行前或任务状态为等待中时修改。
其他参数只能在迁移任务执行前修改。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

smc:ModifyReplicationJobAttribute

update

*ReplicationJob

acs:smc:{#regionId}:{#accountId}:replicationjob/{#JobId}

无

请求参数

名称	类型	必填	描述	示例值
JobId	string	是	迁移任务 ID。	j-bp19vlwm0tyigbmj****
Name	string	否	迁移任务名称。迁移任务的名称需满足以下要求：任务名称必须唯一。长度为 2~128 个英文或中文字符，必须以大小写字母或中文开头，不能以`http://`和`https://`开头，可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。	testMigrationTaskName
Description	string	否	迁移任务描述。长度应为 2~128 个英文或中文字符，必须以大小写字母或中文开头，不能以`http://`和`https://`开头，可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。	This_is_my_migration_task
TargetType	string	否	迁移交付的目标类型。仅支持在迁移任务启动前修改。取值范围： Image：迁移成功后，SMC 为您的源服务器生成阿里云镜像，您可使用该镜像创建 ECS 实例达到迁移至阿里云的目的。 ContainerImage：迁移成功后，SMC 为您的源服务器生成容器镜像，您可以在容器镜像服务中使用该镜像。 TargetInstance：迁移成功后，SMC 将您的迁移源直接迁移至目标实例。当您设置该参数值时，您需要同时指定`InstanceId`参数。说明该参数的取值不区分大小写。 Windows 操作系统和 Arm 架构操作系统不支持迁移至容器镜像。	Image
ScheduledStartTime	string	否	设置迁移任务的执行时间。SMC 在指定时间自动为您启动迁移任务。执行时间遵循 ISO8601 标准，并需要使用 UTC 时间，格式为 YYYY-MM-DDThh:mm:ssZ。例如，2018-01-01T12:00:00Z，表示北京时间 2018 年 01 月 01 日 20 点 00 分 00 秒。说明当执行时间为空时，SMC 不自动启动迁移任务，您需要调用 StartReplicationJob 启动。	2019-06-04T13:35:00Z
ImageName	string	否	迁移任务交付的目标镜像名称。目标镜像的名称需满足以下要求：同一阿里云地域下，镜像名称必须唯一。长度为 2~128 个英文或中文字符，必须以大小写字母或中文开头，不能以`http://`和`https://`开头，可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。说明如果迁移任务运行过程中，当前地域已经存在相同名称的镜像，则系统默认在镜像名称后面添加迁移任务 ID（JobId）作为后缀，如：ImageName-JobId。	testAliCloudImageName
InstanceId	string	否	目标实例 ID。	i-bp1f1dvfto1sigz5****
SystemDiskSize	integer	否	目标阿里云服务器 ECS 的系统盘大小，单位：GiB。取值范围为 20~500。说明参数取值需要大于源服务器系统盘实际占用大小，例如，源系统盘大小为 500 GiB，实际占用 100 GiB，则该参数取值需大于 100 GiB。	50
Frequency	integer	否	增量迁移任务运行的时间间隔，单位：小时。取值范围为 1~168。 `RunOnce`参数值为 false 时，该参数为必填参数。	10
MaxNumberOfImageToKeep	integer	否	增量迁移任务默认保留的最大镜像数。取值范围为 1~10。 `RunOnce`参数值为 false 时，该参数为必填参数。	5
InstanceType	string	否	中转实例的实例规格。调用 DescribeInstanceTypes 可查询云服务器 ECS 提供的实例规格。指定该参数后，系统会选择该实例规格创建中转实例。若该实例规格库存不足，则迁移任务创建失败。不指定该参数时，系统会默认按照一定顺序选择实例规格来创建中转实例，详情请参见SMC FAQ 中转实例规格有哪些。	ecs.c5.large
LaunchTemplateId	string	否	实例启动模板 ID。	lt-bp16jovvln1cgaaq****
LaunchTemplateVersion	string	否	实例启动模板的版本。	Latest
InstanceRamRole	string	否	实例 RAM 角色名称。	SMCAdmin
ContainerNamespace	string	否	Docker 的命名空间。关于 Docker 容器镜像详情请参见容器镜像服务。	testNamespace
ContainerRepository	string	否	Docker 的镜像仓库。关于 Docker 容器镜像详情请参见容器镜像服务。	testRepository
ContainerTag	string	否	Docker 的镜像标签。关于 Docker 容器镜像详情请参见容器镜像服务。	CentOS:v1
ValidTime	string	否	迁移任务的过期时间。取值范围：迁移任务创建时间+7 天~迁移任务创建时间+90 天过期时间只允许迁移任务在 Ready（未开始）、Running（运行中）、Stopped（已暂停）、InError（出错）或 Waiting（等待中）状态下修改。过期时间须遵循 ISO8601 标准，并需要使用 UTC+0 时间，格式为`YYYY-MM-DDThh:mm:ssZ`。例如，2018-01-01T12:00:00Z，表示北京时间 2018 年 01 月 01 日 20 点 00 分 00 秒。过期时间设置为空，表示任务无限期有效。任务到期后会被标记为过期状态，保存 7 天，7 天后系统会自动清理。默认值：迁移任务创建时间+30 天（表示迁移任务的默认有效期为创建后 30 天）。	2019-06-04T13:35:00Z
SystemDiskPart	array<object>	否	系统盘分区列表。
	object	否	系统盘分区列表。
SizeBytes	integer	否	目标系统盘分区 N 大小。单位：Byte。默认为源系统盘分区大小。说明分区空间大小不能超过系统盘空间大小，并且在系统盘下所有分区空间大小之和不能超过系统盘空间大小。	254803968
Block	boolean	否	目标系统盘分区 N 是否开启块复制。取值范围： true。 false。	true
Device	string	否	目标系统盘分区 N 设备标识。说明 N 的实际取值请参考迁移源的分区设备标识。	0_1
DataDisk	array<object>	否	数据盘列表。
	array<object>	否	数据盘列表。
Index	integer	否	目标阿里云服务器 ECS 的数据盘顺序。取值范围为 1~16。初始值为 1。说明您只能为源服务器中存在的数据盘创建目标数据盘。	1
Part	array	否	分区列表。
	object	否	分区列表。
SizeBytes	integer	否	目标数据盘 N 分区 N 的大小。单位：Byte。默认为源数据盘分区大小。说明分区空间大小不能超过数据盘空间大小，并且在同一数据盘下所有分区空间大小之和不能超过数据盘空间大小。	254803968
Block	boolean	否	目标数据盘 N 分区 N 是否开启块复制。取值范围： true。 false。	true
Device	string	否	目标数据盘 N 分区 N 对应的分区设备标识。说明 N 的实际取值请参考迁移源的分区设备标识。	0_1
Size	integer	否	目标阿里云服务器 ECS 的数据盘大小，单位：GiB。取值范围为 20~32768。说明参数取值需要大于源服务器数据盘实际占用大小。例如，源数据盘大小为 500 GiB，实际占用 100 GiB，则该参数取值需大于 100 GiB。	100
NetMode	integer	否	数据传输网络模式。取值范围： 0：表示公网传输模式。此时要求您的源服务器能够访问公网，迁云数据从公网传输。 2：表示内网传输模式，选用此模式必须设置 VSwitchId 参数（VpcId 参数可以不设置，服务内部可以通过接口反查出来）。	0
VSwitchId	string	否	指定 VPC 下的虚拟交换机 ID。	vsw-bp1ddbrxdlrcbim46****
VpcId	string	否	已配置高速通道服务或者 VPN 网关的 VPC ID。	vpc-bp1vwnn14rqpyiczj****
ReplicationParameters	string	否	复制驱动器的参数信息。参数信息为 JSON 格式键值对，键值固定。最大长度：2048 个字符。复制驱动器是指，复制源服务器数据到中转实例时所使用的工具。不同复制驱动器支持参数可能不同。复制驱动器 SMT 目前支持以下参数： bandwidth_limit：传输速度带宽限制。 compress_level：传输压缩率。 checksum：是否开启 checksum 校验。复制驱动器的取值，请参见 DescribeSourceServers 的返回参数`SourceServers.ReplicationDriver`。	{"bandwidth_limit":0,"compress_level":1,"checksum":true}

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	1C488B66-B819-4D14-8711-C4EAAA13AC01

示例

正常返回示例

JSON格式

{
  "RequestId": "1C488B66-B819-4D14-8711-C4EAAA13AC01"
}

错误码

HTTP status code	错误码	错误信息	描述
400	DataDisk.DuplicateIndex	The source server data disk cannot contain the same index.	迁移源数据盘包含相同的索引，请检查磁盘索引是否重复。
400	ReplicationJobDataDiskIndex.Invalid	The specified replication job contains data disk index not found in source server.	迁移任务包含的数据盘索引在迁移源中不存在。
400	ReplicationJobName.Duplicate	The specified replication job name already exists.	迁移任务名称已存在，请修改迁移任务名称。
400	ReplicationJob.InvalidStatus	The specified replication job status: %s is invalid. This operation can only be performed in the following status: %s.	迁移任务的状态：%s 是无效的。该操作只能在以下状态进行：%s。
400	ReplicationJob.InvalidBusinessStatus	The specified business status: %s of the replication job is invalid. This operation can only be performed in the following status: %s.	迁移任务的业务状态：%s 是无效的。该操作只能在以下业务状态进行：%s。
400	ImageName.UsedByReplicationJob	The specified imageName: "%s" was used by another replication job in the current region.	镜像名称“%s”被当前地域的另一个迁移任务使用。
500	InternalError	An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.	内部错误，请重试。如果多次尝试失败，请提交工单。

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

变更历史

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