CreateMigrationJob
最近更新时间: 2025-10-20 17:05:51
1. 接口描述
接口请求域名： csm.api3.fincloud.tencent.cn。
创建在线迁移任务
默认接口请求频率限制：20次/秒。
接口更新时间：2024-11-07 16:44:53。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：CreateMigrationJob |
| Version | 是 | 否 | String | 公共参数，本接口取值：2021-09-15 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| SourceServerId | 是 | 否 | String | 源端机器ID |
| SystemDiskInfo | 是 | 否 | SystemDiskInfo | 待迁移的系统盘信息 |
| Mode | 是 | 否 | Uint64 | 迁移任务网络模式，取值范围有[0，2]，0代表默认模式，2代表内网迁移模式场景2； |
| TargetRegion | 是 | 否 | String | 迁移任务的目标地域 |
| Name | 否 | 否 | String | 迁移任务名称，长度为[1-128]个中英文数字字符，不能包含单引号'、双引号"、分号;以及反斜杠\； |
| TargetType | 否 | 否 | String | 迁移任务的目标结果类型，取值范围['Image','Instance', "Lh-Image", "Lh-Instance"] |
| ImageName | 否 | 否 | String | 迁移任务的目标镜像名称；镜像名称需要符合自定义镜像名称规范，且在目的地域下唯一，如果填入的镜像名称不唯一，迁移后台会重命名镜像名称，格式为镜像名_任务ID：testImageName_migrate-xxxxxxxx |
| DataDisksInfo | 否 | 否 | Array of DataDiskInfo | 待迁移的数据盘信息 |
| Description | 否 | 否 | String | 迁移任务详细描述，最大长度为256个中英文数字字符，不能包含单引号'、双引号"、分号;以及反斜杠\； |
| InstanceId | 否 | 否 | String | 迁移任务的目的实例ID |
| MigrationConfigInfo | 否 | 否 | MigrationConfigInfo | 迁移任务详细配置信息 |
| SecurityGroup | 否 | 否 | String | 迁移中转实例的安全组ID |
| VpcId | 否 | 否 | String | 迁移中转实例的私有网络ID |
| StartTime | 否 | 否 | String | 迁移任务启动时间，UTC+0时区，格式为YYYY-MM-DDThh:mm:ssZ，必须大于等于目前的时间；如果为空，代表只创建任务，待后续触发启动任务； |
| SubnetId | 否 | 否 | String | 迁移中转实例的子网ID |
| InstanceType | 否 | 否 | String | 迁移中转实例的机型，机型规格取值可以参考cvm机型文档，暂不支持裸金属机型； |
| IncrementalMigration | 否 | 否 | Uint64 | 是否开启自动增量迁移 |
| IncrementalTime | 否 | 否 | String | 自动增量迁移的结束时间 |
| OneClickJobId | 否 | 否 | String | 一键迁移任务ID |
| RunMode | 否 | 否 | String | 任务运行模式，设置任务启动的时机。可选值为["Delayed", "Immediate", "Timed"]，默认值为"Delayed"，即创建后任务不启动；如果设置了启动时间StartTime参数，则任务运行模式为Timed；创建任务后需要立即运行，设置为Immediate |
| ExcludePathList | 否 | 否 | String | 要排除的文件或文件夹列表 |
| UserIntentList | 否 | 否 | String | 工具自定义的用户意图 |
| Product | 否 | 否 | String | 迁移产品类型 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| JobId | String | 迁移任务ID |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue.IncrementalTimeGreaterThanSevenDays | 迁移任务的增量迁移时间大于7天。 |
| InvalidParameterValue.IncrementalTimeLessThanOneHour | 迁移任务的增量迁移时间小于1小时。 |
| UnsupportedOperation.MigrateJobCreateFullCvmImage | 迁移任务不支持创建整机镜像。 |
| InvalidParameterValue.InvalidSourceServerIdMalformed | 无效迁移源ID。指定的迁移源ID格式错误。 |
| FailedOperation.NoAvailableIpAddressCountInSubnet | 子网可用IP已耗尽。 |
| InvalidParameterValue.SubnetNotExist | 指定的子网不存在。 |
| InvalidParameterValue.MigrateNotSupportInstanceType | 迁移不支持的实例类型。 |
| ResourceNotFound.InvalidInstanceIdNotFound | 没有找到相应实例。 |
| InvalidParameterValue.InvalidRegionNotFound | 无效的地域。 |
| InvalidParameterValue.SystemDiskSizeTooLarge | 系统盘太大。 |
| InvalidParameterValue.DataDiskSizeTooLarge | 数据盘太大。 |
| InvalidParameterValue.VpcIdSubnetIdNotMatch | 指定的VpcId和SubnetId不匹配。 |
| InvalidParameterValue.MigrateJobNameExist | 指定的迁移任务名称已经存在。 |
| LimitExceeded.MigrateJobLimitExceeded | 迁移任务达到了最大值， 请联系管理员。 |
| InvalidParameterValue.InvalidDataDiskIndex | 非法的数据盘索引。在指定的迁移源中不存在。 |
| InvalidParameterValue.VpcIdMalformed | VPC IDxxx不合要求，请提供规范的Vpc ID， 类似vpc-xxxxxxxx，字母x代表小写字符或者数字。 |
| InvalidParameterValue.SubnetIdMalformed | 子网ID不合要求，请提供规范的子网ID，类似subnet-xxxxxxxx，字母x代表小写字符或者数字 |
| InvalidParameterValue.TooLarge | 参数值超过最大限制。 |
| ResourceNotFound.InvalidLiveMigrateOnlineSourceServerId | 指定的迁移源非在线状态。 |
| FailedOperation.SourceServerRelatedUnFinishedJob | 指定的迁移源关联了未完成的迁移任务。 |
| InvalidParameterValue.ParameterValueContainsIllegalCharacter | 无效参数值。参数值中包含非法字符。 |
| InvalidParameterValue.TooShort | 无效参数值。参数值太短。 |
| InvalidParameterValue.InvalidTimeFormat | 时间格式不合法。 |
| InvalidParameterValue.TooLong | 无效参数值。参数值太长。 |