数据结构
最近更新时间: 2025-10-20 17:05:52
DataDiskInfo
源端机器数据盘信息
被如下接口引用:CreateMigrationJob、CreateSourceServer、CreateTransitInstance、DescribeMigrationJobs、DescribeSourceServers
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Index | 是 | 否 | Uint64 | 数据盘顺序,从1开始计数 |
| PartitionStyle | 否 | 否 | String | 数据盘分区方式,如‘MBR’,'GPT' |
| Device | 是 | 否 | String | 数据盘设备名 |
| MountPoint | 否 | 否 | String | 数据盘挂载点 |
| Partitions | 否 | 否 | Array of Partition | 数据盘分区列表 |
| Size | 是 | 否 | Uint64 | 数据盘大小,单位GB |
| Block | 否 | 否 | BlockMigrate | 支持块迁移 |
MigrateDesc
迁移结果描述
被如下接口引用:DescribeMigrationJobs
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ErrorMessage | 否 | 否 | String | 错误信息 |
| ErrorId | 否 | 否 | String | 错误ID |
JobDeniedAction
迁移任务禁止的操作列表
被如下接口引用:DescribeMigrationJobDeniedActions
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| JobId | 否 | 否 | String | 迁移任务ID |
| DeniedActions | 否 | 否 | Array of DeniedAction | 禁止的操作列表 |
SystemDiskInfo
源端机器系统盘信息
被如下接口引用:CreateMigrationJob、CreateSourceServer、CreateTransitInstance、DescribeMigrationJobs、DescribeSourceServers
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Device | 是 | 否 | String | 源端机器系统盘设备名称 |
| MountPoint | 否 | 否 | String | 源端机器系统盘设备挂载点 |
| Size | 是 | 否 | Uint64 | 源端机器系统盘大小,单位GB |
| Partitions | 否 | 否 | Array of Partition | 源端机器系统盘分区列表 |
| PartitionStyle | 否 | 否 | String | 源端机器系统盘分区方式,如‘MBR’,'GPT' |
| Block | 否 | 否 | BlockMigrate | 块迁移支持参数 |
MigrationJob
在线迁移任务详情
被如下接口引用:DescribeMigrationJobs
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| TargetType | 否 | 否 | String | 迁移任务的目标结果类型,取值有'Image','Instance' |
| SourceServerId | 否 | 否 | String | 迁移源ID |
| SecurityGroup | 否 | 否 | String | 安全组ID |
| TargetRegion | 否 | 否 | String | 迁移任务的目标地域 |
| Progress | 否 | 否 | Float | 迁移任务的进度 |
| EndTime | 否 | 否 | String | 迁移任务的结束时间 |
| Status | 否 | 否 | String | 迁移任务状态,取值有'PENDING'(待启动),'RUNNING'(迁移中),'SUCCESS'(成功),'FAILED'(失败),'STOPPING'(停止中),'STOPPED'(已停止),'DELETING'(删除中),'DELETED'(已删除) |
| UpdateTime | 否 | 否 | String | 迁移任务的更新时间 |
| VpcId | 否 | 否 | String | 迁移中转实例所属的私有网络ID |
| Description | 否 | 否 | String | 迁移任务描述 |
| InstanceId | 否 | 否 | String | 迁移的目的实例ID |
| MigrationConfigInfo | 否 | 否 | MigrationConfigInfo | 数据同步过程的配置信息 |
| JobId | 否 | 否 | String | 迁移任务ID |
| ImageId | 否 | 否 | String | 镜像ID |
| SubnetId | 否 | 否 | String | 迁移中转实例所属的子网ID |
| InstanceType | 否 | 否 | String | 迁移中转实例的机型 |
| DataDisksInfo | 否 | 否 | Array of DataDiskInfo | 迁移的数据盘信息 |
| Name | 否 | 否 | String | 迁移任务名称 |
| ImageName | 否 | 否 | String | 镜像名称 |
| Mode | 否 | 否 | Uint64 | 迁移任务网络模式 |
| SystemDiskInfo | 否 | 否 | SystemDiskInfo | 迁移的系统盘信息 |
| StartTime | 否 | 否 | String | 迁移任务启动时间 |
| MigrateResult | 否 | 否 | MigrateResult | 迁移任务结果 |
| CreateTime | 否 | 否 | String | 迁移任务的创建时间 |
| TransitInstanceId | 否 | 否 | String | 迁移目标是镜像时,创建的中转机器的ID |
| IncrementalMigration | 否 | 否 | Uint64 | 是否开启自动增量迁移 |
| IncrementalTime | 否 | 否 | String | 自动增量迁移的结束时间 |
| MigrateResults | 否 | 否 | MigrateResults | 新的迁移任务结果 |
| LastReportMessage | 否 | 否 | LastReportMessage | 上一次上报消息 |
| OneClickJobId | 否 | 否 | String | 一键迁移任务ID |
| RunMode | 否 | 否 | String | 运行模式 |
| RemainingTimeEstimate | 否 | 否 | String | 迁移预估剩余时间,单位min |
| LastSpeed | 否 | 否 | String | 迁移速度,单位KB/s |
| ExcludePathList | 否 | 否 | String | 迁移时需要过滤目录/文件列表 |
| UserIntentList | 否 | 否 | String | 客户扩缩容的设置参数 |
| Product | 否 | 否 | String | 迁移产品类型,取值范围["lh", "cvm"] |
SystemInfo
源端机器系统详细信息
被如下接口引用:CreateSourceServer、DescribeSourceServers
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| KernelVersion | 否 | 否 | String | 源端机器系统内核版本,如‘3.10.107-1-tlinux2_kvm_guest-0050’ |
| HostName | 否 | 否 | String | 源端机器主机名,如'VM_78_149_centos' |
| OsName | 否 | 否 | String | 源端机器系统名称,如'CentOS Linux release 7.2 (Final)' |
Filter
描述键值对过滤器,用于条件过滤查询。例如过滤ID、名称、状态等 若存在多个Filter时,Filter间的关系为逻辑与(AND)关系。 若同一个Filter存在多个Values,同一Filter下Values间的关系为逻辑或(OR)关系。 以DescribeInstances接口的Filter为例。若我们需要查询可用区(zone)为xxx 并且 实例计费模式(instance-charge-type)为包年包月 或者 按量计费的实例时,可如下实现: Filters.0.Name=zone &Filters.0.Values.0=xxx &Filters.1.Name=instance-charge-type &Filters.1.Values.0=PREPAID &Filters.1.Values.1=POSTPAID_BY_HOUR
被如下接口引用:DescribeMigrationJobs、DescribeSourceServers
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Values | 是 | 否 | Array of String | 字段的过滤值。 |
| Name | 是 | 否 | String | 需要过滤的字段。 |
ServerInfo
源端机器的详细信息,比如配置,网络等等
被如下接口引用:CreateSourceServer、DescribeSourceServers
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ProcessorNum | 否 | 否 | Uint64 | 源端机器CPU核数 |
| Ip | 否 | 否 | String | 源端机器内网ip |
| Mac | 否 | 否 | String | 源端机器mac地址 |
| Memory | 否 | 否 | Uint64 | 源端机器内存大小,单位GB |
| BootMode | 否 | 否 | String | 源端机器启动模式,如'BIOS'、'UEFI' |
DiskForMigrate
磁盘信息,用于创建中转实例
被如下接口引用:DescribeTransitInstance
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| DiskSize | 否 | 否 | Uint64 | 云硬盘大小,单位 GB。取值范围是[1, 450]。 |
| DiskId | 否 | 否 | String | CBS 云硬盘 ID。 作为入参时,不需要传该参数。 |
MigrateResults
描述在线迁移任务结果
被如下接口引用:DescribeMigrationJobs
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| State | 否 | 否 | String | 迁移失败时的错误步骤, 如File Transmission Stopped表示同步暂停,Failed exitLiveMigrateInstance表示退出迁移失败;最多128个字符。 |
| Result | 否 | 否 | String | 迁移结果,如'succ'、'normalFailed'、'malformedFailed';最多128个字符 |
| Desc | 否 | 否 | MigrateDesc | 迁移任务成功失败描述;。 |
ClientSysInfo
用于迁移时传递客户端系统信息。
被如下接口引用:LiveMigrateInstance、LiveMigrateLhInstance
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| OsType | 否 | 否 | String | 操作系统 |
| OsVersion | 否 | 否 | String | 操作系统版本 |
| DiskSize | 否 | 否 | Array of Uint64 | 需要导入的系统盘数据盘信息 |
| ExtraInfo | 否 | 否 | String | 额外信息 |
Partition
源端机器磁盘分区信息
被如下接口引用:CreateMigrationJob、CreateSourceServer、CreateTransitInstance、DescribeMigrationJobs、DescribeSourceServers
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Device | 是 | 否 | String | 分区设备名 |
| MountPoint | 否 | 否 | String | 分区挂载点 |
| Size | 是 | 否 | Uint64 | 分区大小,单位GB |
| Bootable | 否 | 否 | Bool | 是否是启动分区,默认为False |
| FileSystem | 否 | 否 | String | 分区文件系统类型 |
| Block | 否 | 否 | BlockMigrate | 块迁移支持 |
MigrateResult
在线迁移迁移任务结果
被如下接口引用:DescribeMigrationJobs、ModifyMigrationJob
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| State | 否 | 否 | String | 迁移失败时的错误步骤, 如File Transmission Stopped表示同步暂停,Failed exitLiveMigrateInstance表示退出迁移失败;最多128个字符。 |
| Result | 否 | 否 | String | 迁移结果,如'succ'、'normalFailed'、'malformedFailed';最多128个字符 |
| Desc | 否 | 否 | String | 迁移任务成功失败描述;最多1024个字符。 |
OneClickMigrationJob
一键迁移任务参数
被如下接口引用:CreateOneClickMigrationJobs
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| SourceInstanceId | 否 | 否 | String | 源机器实例ID,长度[1-128]字符,不含'"', "'", ";", "", "|" |
| OsType | 否 | 否 | String | 源机器系统类型,取值有linux和windows |
| TargetRegion | 否 | 否 | String | 目的地域 |
| PrivateIp | 否 | 否 | String | 源机器内网IP,长度[7-15]字符,不含'"', "'", ";", "", "|" |
| Uuid | 否 | 否 | String | 源机器唯一ID或序列号,例如SerialNumber,长度[1-128]字符,不含'"', "'", ";", "", "|" |
| SourceInstanceName | 否 | 否 | String | 源机器实例名称,长度[1-256]字符,不含'"', "'", ";", "", "|" |
| PublicIp | 否 | 否 | String | 源机器公网IP,长度[7-15]字符,不含'"', "'", ";", "", "|" |
| OsName | 否 | 否 | String | 源机器系统英文名称, 长度[1-128]字符,不含'"', "'", ";", "", "|" |
| TargetInstanceId | 否 | 否 | String | 目的机器实例ID |
| ImageName | 否 | 否 | String | 镜像名称 |
| Mode | 否 | 否 | Uint64 | 迁移的网络模式,取值0、2、3。其中0代表公网迁移,2和3代表内网迁移。默认为0。 |
| TargetType | 否 | 否 | String | 迁移目标类型,取值有Instance和Image |
SourceServerDeniedAction
迁移源禁止操作列表
被如下接口引用:DescribeSourceServerDeniedActions
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| SourceServerId | 否 | 否 | String | 迁移源ID |
| DeniedActions | 否 | 否 | Array of DeniedAction | 禁止的操作列表 |
SourceSystemInfo
迁移源的系统信息
被如下接口引用:ExitLiveMigrateInstance、ExitLiveMigrateLhInstance
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| OsName | 否 | 否 | String | 源端机器系统名称 |
| KernelVersion | 否 | 否 | String | 源端机器系统内核版本 |
| Architecture | 否 | 否 | String | 源端机器系统架构 |
TransitInstance
迁移中转实例
被如下接口引用:DescribeTransitInstance
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| InstanceId | 否 | 否 | String | 实例 ID |
| SystemDisk | 否 | 否 | DiskForMigrate | 实例系统盘信息 |
| CPU | 否 | 否 | Uint64 | 实例的 CPU 核数,单位:核。 |
| Memory | 否 | 否 | Uint64 | 实例内存容量,单位:GB 。 |
| Uuid | 否 | 否 | String | 实例全局唯一 ID。 |
| OsType | 否 | 否 | String | 操作系统平台类型,如 linux, windows。 |
| InstanceType | 否 | 否 | String | CVM 实例机型 |
| PublicIpAddresses | 否 | 否 | Array of String | 实例主网卡的公网 IP。 |
| InstanceState | 否 | 否 | String | 实例状态。 |
| LatestOperation | 否 | 否 | String | 实例的最新操作。例:StopInstances、ResetInstance。注意:此字段可能返回 空值,表示取不到有效值。 |
| LatestOperationState | 否 | 否 | String | 实例的最新操作状态。取值范围: SUCCESS:表示操作成功 OPERATING:表示操作执行中 FAILED:表示操作失败 注意:此字段可能返回 空值,表示取不到有效值。 |
| LatestOperationRequestId | 否 | 否 | String | 实例最新操作的唯一请求 ID。 注意:此字段可能返回 空值,表示取不到有效值。 |
DeniedAction
禁止操作列表
被如下接口引用:DescribeMigrationJobDeniedActions、DescribeSourceServerDeniedActions
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 否 | 否 | String | 操作名,也就是接口名 |
| Code | 否 | 否 | String | 错误码 |
| Message | 否 | 否 | String | 详细报错信息 |
MigrationConfigInfo
迁移任务配置详细信息
被如下接口引用:CreateMigrationJob、DescribeMigrationJobs
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Checksum | 否 | 否 | Bool | 迁移任务是否开启强校验,默认为False(不开启),True为开启;开启强校验会减慢迁移速度; |
| BandwidthLimit | 否 | 否 | String | 迁移任务的限速,单位KB/S,默认为空,即不限速。 |
SourceServer
源端机器信息描述
被如下接口引用:DescribeSourceServers
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Status | 否 | 否 | String | 源端机器状态:'OFFLINE'(离线),'ONLINE'(在线),'MIGRATING'(迁移中),'DELETING'(删除中),'DELETED'(已删除) |
| UpdateTime | 否 | 否 | String | 源端机器更新时间 |
| DataDisksInfo | 否 | 否 | Array of DataDiskInfo | 源端机器数据盘详细信息 |
| Name | 否 | 否 | String | 源端机器名称 |
| ClientVersion | 否 | 否 | String | 迁移工具版本号,如'2.1.3' |
| SystemInfo | 否 | 否 | SystemInfo | 源端机器系统详细信息 |
| SourceServerId | 否 | 否 | String | 源端机器ID |
| ServerInfo | 否 | 否 | ServerInfo | 源端机器配置相关信息 |
| SystemDiskInfo | 否 | 否 | SystemDiskInfo | 源端机器系统盘详细信息 |
| Architecture | 否 | 否 | String | 源端机器系统架构,如'x86_64' |
| EndTime | 否 | 否 | String | 源端机器结束时间 |
| OsType | 否 | 否 | String | 源端机器系统类型,如'CentOS' |
| Identifier | 否 | 否 | String | 迁移源唯一标识,长度64个英文数字字符,不能包含其他字符。 |
| CreateTime | 否 | 否 | String | 源端机器导入时间 |
| Description | 否 | 否 | String | 源端机器详细描述 |
| Product | 否 | 否 | String | 迁移产品类型,取值["lh", "cvm"] |
| Platform | 否 | 否 | String | 源机器所在平台 |
| SessionToken | 否 | 否 | String | 用户迁移会话token |
OneClickMigrationJobInfo
一键迁移任务创建结果
被如下接口引用:CreateOneClickMigrationJobs
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| OneClickJobId | 否 | 否 | String | 一键迁移任务ID |
| ApiPublicKey | 否 | 否 | String | 公钥,用于加密用户云api SecretId和SecertKey |
| Script | 否 | 否 | String | 一键迁移命令脚本 |
| TmpSecretId | 否 | 否 | String | 临时密钥ID |
| TmpSecretKey | 否 | 否 | String | 临时密钥Key |
| Token | 否 | 否 | String | 临时密钥Token |
BlockMigrate
块迁移相关参数
被如下接口引用:CreateMigrationJob、CreateSourceServer、CreateTransitInstance、DescribeMigrationJobs、DescribeSourceServers
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Supported | 否 | 否 | Bool | 是否支持块迁移。 |
| Enabled | 否 | 否 | Bool | 是否开启块迁移。 |
LastReportMessage
上一次上报消息
被如下接口引用:DescribeMigrationJobs
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Messages | 否 | 否 | Array of String | 消息列表 |