ModifyMigrationJob
最近更新时间: 2025-10-20 17:05:51
1. 接口描述
接口请求域名： csm.api3.fincloud.tencent.cn。
修改在线迁移任务属性
默认接口请求频率限制：20次/秒。
接口更新时间：2024-11-07 16:45:11。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：ModifyMigrationJob |
| Version | 是 | 否 | String | 公共参数，本接口取值：2021-09-15 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| JobId | 是 | 否 | String | 迁移任务ID |
| Status | 否 | 否 | String | 迁移任务状态 |
| TargetType | 否 | 否 | String | 迁移任务的目标结果类型，取值有'Image','Instance'；当TargetType从Instance修改Image时，需要同时加上ImageName参数； |
| Description | 否 | 否 | String | 迁移任务详细描述，最大长度为256个中英文数字字符，不能包含单引号'、双引号"、分号;以及反斜杠\； |
| InstanceId | 否 | 否 | String | 迁移任务的目的实例ID |
| SecurityGroup | 否 | 否 | String | 迁移任务中转实例的安全组ID |
| ImageName | 否 | 否 | String | 迁移任务的目标镜像名称；镜像名称需要符合自定义镜像名称规范，且在目的地域下唯一，如果填入的镜像名称不唯一，迁移后台会重命名镜像名称，格式为镜像名_任务ID：testImageName_migrate-xxxxxxxx；如果目标类型为实例，则修改无效； |
| StartTime | 否 | 否 | String | 迁移任务启动时间，UTC+0时区，格式为YYYY-MM-DDThh:mm:ssZ，必须大于等于目前的时间；如果为空，代表只创建任务，待后续触发启动任务； |
| Progress | 否 | 否 | String | 迁移任务的进度 |
| MigrateResult | 否 | 否 | MigrateResult | 迁移任务的结果信息 |
| ImageId | 否 | 否 | String | 迁移任务创建的镜像ID |
| InstanceType | 否 | 否 | String | 迁移中转实例的机型，机型规格取值可以参考cvm机型文档，暂不支持裸金属机型； |
| Name | 否 | 否 | String | 迁移任务名称，长度为[1-128]个中英文数字字符，不能包含单引号'、双引号"、分号;以及反斜杠\； |
| TransitInstanceId | 否 | 否 | String | 迁移目标是镜像时，创建的中转实例ID |
| IncrementalTime | 否 | 否 | String | 自动增量迁移的结束时间 |
| LastMessage | 否 | 否 | String | 需要上报的最新消息 |
| LastSpeed | 否 | 否 | String | 上次的速度，单位为KB/s |
| RemainingTimeEstimate | 否 | 否 | String | 迁移剩余时间，单位为分钟 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue.InvalidTimeFormat | 时间格式不合法。 |
| InvalidParameterValue.ParameterValueContainsIllegalCharacter | 无效参数值。参数值中包含非法字符。 |
| InvalidParameterValue.InvalidTaskIdFormat | 任务ID格式错误 |
| InvalidParameterValue.TooLarge | 参数值超过最大限制。 |
| InvalidParameterValue.MigrateJobNameExist | 指定的迁移任务名称已经存在。 |
| FailedOperation.JobIdNotExist | jobId不存在。 |
| FailedOperation.MigrateJobStatusNotSupport | 迁移任务的状态不支持该操作。 |
| InvalidParameterValue.InvalidProgressNumber | 无效的进度值。 |
| ResourceNotFound.InvalidInstanceIdNotFound | 没有找到相应实例。 |
| InvalidParameterValue.MigrateNotSupportInstanceType | 迁移不支持的实例类型。 |
| InvalidParameterValue.InvalidMigrateJobIdMalformed | 无效迁移任务ID。指定的迁移任务ID格式错误。 |
| InvalidParameterValue.IncrementalTimeLessThanOneHour | 迁移任务的增量迁移时间小于1小时。 |
| InvalidParameterValue.IncrementalTimeGreaterThanSevenDays | 迁移任务的增量迁移时间大于7天。 |