You need to enable JavaScript to run this app.
导航
服务器迁移中心
  • 文档首页
    • /
  • 服务器迁移中心

DescribeMigrationJobs

最近更新时间：2024.03.26 14:17:57

首次发布时间：2023.07.18 10:22:41

我的收藏

调用DescribeMigrationJobs接口，查询迁移任务信息。

请求参数

名称类型是否必填示例值描述
ActionString是DescribeMigrationJobs要执行的操作，取值： DescribeMigrationSources。
VersionString是2020-04-01API的版本，取值： 2020-04-01。

DestinationRegion

String

否

cn-beijing

目标地域，最大长度为255个字符。您可以调用DescribeRegions接口查询获取。

根据目的区域查询时，需要传入该参数。

DestinationType.N

String

否

DestinationType.1=ECSInstance&DestinationType.2=ECSImage

迁移目标类型，最多支持5个类型。取值：

  • ECSInstance：云服务器实例
  • ECSImage：云服务器镜像
  • ECSSystem：云服务器操作系统

说明

  • 参数 - N：表示迁移目标类型的序号。
  • 多个DestinationType之间用&分隔。
  • 根据迁移目标类型查询时，需要传入该参数。
PageNumberInteger否1分页数。

PageSize

Integer

否

10

页表大小。

  • 取值范围：1~50
  • 默认值：10

MigrationJobId

String

否

job-3tiegs1y963vj0****

迁移任务ID。

根据迁移任务ID查询时，需要传入该参数。

MigrationJobName

String

否

VM迁移至ECS

迁移任务名，最大长度为255个字符。

根据迁移任务名称查询时，需要传入该参数。

MigrationJobStateSourceState

String

否

Success

迁移任务状态，取值：

  • Preparing：准备中
  • Replicating：迁移中
  • Success：已完成
  • Failed：失败
  • Waiting：等待中
  • Cleaning：清理中
  • Terminated：已终止
  • Terminating：终止中
  • Warning：异常

ProjectName

String

否

project_a

迁移任务所属项目，一个任务只能归属于一个项目。

  • 只能包含字母、数字、下划线“_”、点“.”和中划线“-”。
  • 长度限制在64个字符以内。

TagFilters.N.Key

String

是

TagFilters.1.Key=k1

根据标签查询资源时指定的标签键。

  • 参数 - N：表示标签键的序号，取值范围：1～10。
  • 多个标签键之间用&分隔，不允许重复。

说明

  • 不传则表示查询所有标签。
  • 传入空字符串时，则返回错误码InvalidTagFilterKey.Malformed。

TagFilters.N.Values.N

String

否

TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2

根据标签查询资源时指定的标签值。

  • 第一个N：表示标签键的序号，取值范围：1～10。
  • 第二个N：表示标签值的序号，取值范围：1～3。
  • 多个标签值之间用&分隔。

说明

  • 如果传入该参数，则必须先传入TagFilters.N.Key。
  • 不传则表示查询同一标签键下的所有标签值。
  • 传入空字符串时，表示查询标签值为空的标签。

返回数据

名称类型示例值描述
PageNumberInteger321分页数。
PageSizeInteger3210页表大小。
JobsArray of Struct-符合条件的迁移任务信息。具体请参见下表“ Jobs 结构 ”。
TotalCountInteger321迁移任务总数。

Jobs 结构

名称类型示例值描述
CreatedAtString2023-05-01T12:00:00+08:00迁移任务创建时间。
DestinationConfigStruct-目标配置。具体请参见下表“DestinationConfig 结构”。
FinishedAtString2023-05-01T14:00:00+08:00迁移任务完成时间。
LastSyncTimeString2023-05-01T15:00:00+08:00最近一次同步时间。
MigrationJobDescriptionString用于迁移本地虚拟机迁移任务描述。
MigrationJobIdStringjob-3tiegs1y963vj0****迁移任务ID。
MigrationJobNameStringVM迁移至ECS迁移任务名。
MigrationSourceIdStrings-iegs1y963vj0****迁移源ID。
MigrationSourceNameStrings-iegs1y963vj0****迁移源名称。
NetworkConfigStruct-网络迁移配置。具体请参见下表“NetworkConfig 结构”。
ProgressInteger3210迁移任务进度，以百分比为单位，例如：10表示任务进度为10%。
ProjectNameStringproject_a迁移任务所属项目。
SourceProjectNameStringproject_a迁移任务对应的迁移源所属项目。
StartedAtString2023-05-01T13:00:00+08:00迁移任务开始时间。
StateStringSuccess迁移任务状态。
SyncConfigStruct-迁移配置。具体请参见下表“SyncConfig 结构”。
SystemConfigStruct-操作系统配置。具体请参见下表“SystemConfig 结构”。
TagsArray of Struct-资源的标签信息，具体请参见下表“Tags 结构”。

TemporaryResources

Array of Struct

-

临时资源信息。具体请参见下表“TemporaryResources 结构”。

说明

仅传入MigrationJobId（迁移任务ID）参数查询具体任务信息时，才会返回本参数。

DestinationConfig 结构

名称类型示例值描述

AutoInstallVirtio11

Boolean

true

是否自动为目标实例或目标镜像安装Virtio1.1驱动。取值：

  • true：默认，自动安装。
  • false：不自动安装。

AutoInstallBlkNone

Boolean

true

是否自动为目标实例或目标镜像安装blk-none。取值：

  • true：自动安装。
  • false：默认，不自动安装。

DestinationSystem

String

VeLinux10Centos

目标操作系统。取值：

  • Unknown：未知
  • VeLinux10Centos：表示迁移为veLinux 1.0 CentOS兼容版操作系统。
DestinationTypeStringECSInstance目标类型。
ImageIdStringimage-3tefr6wgx63vj0****目标镜像ID。
ImageNameStringtest目标镜像名称。
InstanceIdStringi-3tigy72q3u3vj0x2****目标实例ID。
InstanceNameStringinstance-test目标实例名称。
RegionStringcn-beijing目标地域。

NetworkConfig 结构

名称类型示例值描述
BandwidthLimitInteger325网络传输带宽，单位 Mbps。

NetworkTransitionMode

String

PublicNetwork

网络传输模式。取值：

  • PublicNetwork：公网传输
  • VPC：内网传输
SubnetIdStringsubnet-3tispp1nai4e8i****子网ID。
TransferIPString172.0.xx.xx网络传输IP。
VpcIdStringvpc-bp15zkdt37pq72zv****私有网络ID。

SyncConfig 结构

名称类型示例值描述
SyncIntervalInteger322增量同步时间间隔，单位小时。

SyncType

String

File

复制类型。取值：

  • File：文件复制
  • Block：块复制
TriggerLastSyncBooleantrue是否开启最后一次增量同步。

SystemConfig 结构

名称类型示例值描述
SourceImageInfoStruct-迁移前实例镜像信息。具体请参见下表“SourceImageInfo 结构”。
TargetImageInfoStruct-迁移后实例镜像信息。具体请参见下表“TargetImageInfo 结构”。

SourceImageInfo 结构

名称类型示例值描述

OS

String

Linux

操作系统。取值：

  • Linux：表示源操作系统为Linux系列操作系统
  • Windows：表示源操作系统为Windows系列操作系统
PlatformStringCentOS操作系统的发行版本。
PlatformVersionString7.6操作系统版本号。

TargetImageInfo 结构

名称类型示例值描述

OS

String

Linux

操作系统。取值：

  • Linux：表示目标实例使用Linux系列操作系统
  • Windows：表示目标实例使用Windows系列操作系统
PlatformStringveLinux操作系统的发行版本。
PlatformVersionString1.0操作系统版本号。

Tags 结构

名称类型示例值描述
KeyStringKey=k1根据标签查询资源时指定的标签键。
ValueStringValue=v1根据标签查询资源时指定的标签值。

TemporaryResources 结构

名称类型示例值描述
AssociatedResourceStruct-已绑定该临时资源的云资源。具体请参见下表“AssociatedResource 结构”。

ProjectName

String

default

临时资源所属的项目。

ResourceIdStringkp-ybp0x6i30gep29******临时资源ID。
ResourceNameStringMigrationKey-job-yd0d5s8n*****临时资源名称。

ResourceStatus

String

Exist

临时资源状态。取值：

  • Exist：未删除
  • Deleted：已删除

ResourceType

String

KeyPair

临时资源类型。取值：

  • Instance：实例
  • KeyPair：密钥对
  • Image：镜像
  • Volume：云盘
  • SecurityGroup：安全组
  • Subnet：子网
  • Vpc：私有网络
  • Eip：公网IP
AssociatedResource 结构
名称类型示例值描述
ResourceIdStringi-3tigy72q3u3vj0x2****绑定该临时资源的云资源ID。

ResourceType

String

Instance

绑定该临时资源的云资源类型。取值：

  • Instance：实例
  • KeyPair：密钥对
  • Image：镜像
  • Volume：云盘
  • SecurityGroup：安全组
  • Subnet：子网
  • Vpc：私有网络
  • Eip：公网IP

请求示例

GET /?Action=DescribeMigrationJobs&Version=2020-04-01 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
Service: smc

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306051605204303A34A*****",
        "Action": "DescribeMigrationJobs",
        "Version": "2020-04-01",
        "Service": "smc",
        "Region": "cn-beijing"
    },
    "Result": {
        "TotalCount": 16,
        "PageNumber": 1,
        "PageSize": 10,
        "Jobs": [
            {
                "MigrationJobId": "job-ycg79lm7wg7grbxxxx",
                "MigrationJobName": "VM迁移至ECS",
                "MigrationJobDescription": "",
                "SourceProjectName": "project_a",
                "CreatedAt": "2023-05-31T14:00:43+08:00",
                "StartedAt": "2023-05-31T14:00:43+08:00",
                "FinishedAt": "",
                "State": "Replicating",
                "Progress": 0,
                "MigrationSourceId": "s-ycg79jgyp8b5ozxxxx",
                "MigrationSourceName": "s-ycg79jgyp8b5oxxxx",
                "Tags": [
                    {
                        "Key": "k1",
                        "Value": "v1"
                    }
                ],
                "DestinationConfig": {
                    "Region": "cn-beijing",
                    "DestinationType": "ECSInstance",
                    "InstanceId": "i-ycg4zh1r13ebgy4xxxx",
                    "InstanceName": "VMwareMigrationTarget",
                    "ImageId": "",
                    "ImageName": "",
                    "AutoInstallVirtio11": true,
                    "AutoInstallBlkNone": true
                },
                "NetworkConfig": {
                    "NetworkTransitionMode": "PublicNetwork",
                    "BandwidthLimit": 0,
                    "TransferIP": "180.xxx.xx.xxx",
                    "VpcId": "",
                    "SubnetId": ""
                },
                "SyncConfig": {
                    "SyncInterval": 1,
                    "TriggerLastSync": false,
                    "SyncType": "Block"
                },
                "SystemConfig": {
                    "SourceImageInfo": {
                        "OS": "Linux",
                        "Platform": "CentOS",
                        "PlatformVersion": "7.6"
                    },
                    "TargetImageInfo": {
                        "OS": "Linux",
                        "Platform": "veLinux",
                        "PlatformVersion": "1.0"
                    }
                },
                "TemporaryResources": [
                    {
                        "AssociatedResource": {
                            "ResourceId": "i-3tigy72q3u3vj0x2****",
                            "ResourceType": "Instance"
                        },
                        "ProjectName": "default",
                        "ResourceId": "kp-ybp0x6i30gep29******",
                        "ResourceName": "MigrationKey-job-yd0d5s8n*****",
                        "ResourceStatus": "Exist",
                        "ResourceType": "KeyPair"
                    }
                ],
                "LastSyncTime": "2023-05-31T14:00:43+08:00"
            }
        ]
    }
}

错误码

HttpCode错误码错误信息描述
400InvalidDestinationRegion.MalformedThe specified DestinationRegion is malformed.指定的DestinationRegion不合法。
400InvalidMigrationJobName.MalformedThe specified MigrationJobName is malformed.指定的MigrationJobName不合法。
400InvalidMigrationJobState.MalformedThe specified MigrationJobState is malformed.指定的MigrationJobState不合法。
400InvalidProjectName.MalformedThe specified ProjectName is malformed.指定的ProjectName不合法。
400InvalidTagFilterKey.ConflictThe specified TagFilterKey already exists.指定的过滤标签键已存在。
400InvalidTagFilterKey.MalformedThe specified TagFilterKey is malformed.指定的标签键不合法。
400InvalidTagFilterValue.MalformedThe specified TagFilterValue already exists.指定的过滤标签值已存在。
400LimitExceeded.MaximumTagFilterKeysYou've reached the limit on the number of TagFilterKeys that you can set.指定的标签过滤键超过最大限制。
400LimitExceeded.MaximumTagFilterResultsYou've reached the limit on the number of resources that you can describe by TagFilters.通过标签过滤出的资源数量超过上限。
400LimitExceeded.MaximumTagFilterValuesYou've reached the limit on the number of TagFilterValues that you can set.指定的标签过滤值超过最大限制。