调用ModifyReplicationJobAttribute修改迁移任务信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
smc:ModifyReplicationJobAttribute | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
JobId | string | 是 | 迁移任务ID。 | j-bp19vlwm0tyigbmj**** |
Name | string | 否 | 迁移任务名称。迁移任务的名称需满足以下要求:
| testMigrationTaskName |
Description | string | 否 | 迁移任务描述。 长度应为2~128个英文或中文字符,必须以大小写字母或中文开头,不能以 | This_is_my_migration_task |
TargetType | string | 否 | 迁移交付的目标类型。仅支持在迁移任务启动前修改。取值范围:
说明
| 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 | 否 | 迁移任务交付的目标镜像名称。目标镜像的名称需满足以下要求:
说明
如果迁移任务运行过程中,当前地域已经存在相同名称的镜像,则系统默认在镜像名称后面添加迁移任务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。
| 10 |
MaxNumberOfImageToKeep | integer | 否 | 增量迁移任务默认保留的最大镜像数。取值范围为1~10。
| 5 |
InstanceType | string | 否 | 中转实例的实例规格。 调用DescribeInstanceTypes可查询云服务器ECS提供的实例规格。
| 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天
默认值:迁移任务创建时间+30天(表示迁移任务的默认有效期为创建后30天)。 | 2019-06-04T13:35:00Z |
SystemDiskPart | object [] | 否 | 系统盘分区列表。 | |
SizeBytes | long | 否 | 目标系统盘分区N大小。单位:Byte。默认为源系统盘分区大小。 说明
分区空间大小不能超过系统盘空间大小,并且在系统盘下所有分区空间大小之和不能超过系统盘空间大小。
| 254803968 |
Block | boolean | 否 | 目标系统盘分区N是否开启块复制。取值范围:
| true |
Device | string | 否 | 目标系统盘分区N设备标识。 说明
N的实际取值请参考迁移源的分区设备标识。
| 0_1 |
DataDisk | object [] | 否 | 数据盘列表。 | |
Index | integer | 否 | 目标阿里云服务器ECS的数据盘顺序。取值范围为1~16。 初始值为1。 说明
您只能为源服务器中存在的数据盘创建目标数据盘。
| 1 |
Part | object [] | 否 | 分区列表。 | |
SizeBytes | long | 否 | 目标数据盘N分区N的大小。单位:Byte。默认为源数据盘分区大小。 说明
分区空间大小不能超过数据盘空间大小,并且在同一数据盘下所有分区空间大小之和不能超过数据盘空间大小。
| 254803968 |
Block | boolean | 否 | 目标数据盘N分区N是否开启块复制。取值范围:
| true |
Device | string | 否 | 目标数据盘N分区N对应的分区设备标识。 说明
N的实际取值请参考迁移源的分区设备标识。
| 0_1 |
Size | integer | 否 | 目标阿里云服务器ECS的数据盘大小,单位:GiB。取值范围为20~32768。 说明
参数取值需要大于源服务器数据盘实际占用大小。例如,源数据盘大小为500 GiB,实际占用100 GiB,则该参数取值需大于100 GiB。
| 100 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "1C488B66-B819-4D14-8711-C4EAAA13AC01"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | DataDisk.DuplicateIndex | The source server data disk cannot contain the same index. | 迁移源数据盘包含相同的索引,请检查磁盘索引是否重复。 |
400 | ReplicationJob.InvalidStatus | The specified replication job status is invalid. | 无效的迁移任务状态。 |
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. | 迁移任务名称已存在,请修改迁移任务名称。 |
500 | InternalError | An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket. | 内部错误,请重试。如果多次尝试失败,请提交工单。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|