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

DescribeMigrationJobs - 查询迁移任务信息

最近更新时间：2024.05.23 10:12:41

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

我的收藏

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

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数
类型
是否必填
示例值
描述
Action
String
是

DescribeMigrationJobs

要执行的操作，取值：DescribeMigrationJobs。

Version
String
是

2020-04-01

API的版本，取值：2020-04-01。

DestinationRegion
String
否

cn-beijing

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

说明

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

DestinationType.N
Array of String
否

DestinationType.1=ECSInstance&DestinationType.2=ECSImage

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

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

说明

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

job-3tiegs1y963vj0******

迁移任务ID。

说明

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

MigrationJobName
String
否

VM迁移至ECS

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

说明

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

MigrationJobState
String
否

Success

迁移任务状态，取值：

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

1

分页数。

PageSize
Integer
否

10

页表大小。

  • 取值范围：1~50
  • 默认为：10
ProjectName
String
否

project_a

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

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

TagFilters.1.Key=k1

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

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

说明

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

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

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

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

说明

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

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数
类型
示例值
描述
Jobs
Array of JobsForDescribeMigrationJobs

--

符合条件的迁移任务信息。

PageNumber
Integer

1

分页数。

PageSize
Integer

10

页表大小。

TotalCount
Integer

30

迁移任务总数。

请求示例

GET /?Action=DescribeMigrationJobs&Version=2020-04-01&MigrationJobId=job-ycg7dvqn59b5oz**** 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",
          "HasSyncedTimes": ""
        },
        "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"
          }
        ],
        "MigrationStateTips": "",
        "LastSyncTime": "2023-05-31T14:00:43+08:00"
      }
    ]
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
400
InvalidDestinationRegion.Malformed
The specified DestinationRegion is malformed.

指定的DestinationRegion不合法。

400
InvalidMigrationJobName.Malformed
The specified MigrationJobName is malformed.

指定的MigrationJobName不合法。

400
InvalidMigrationJobState.Malformed
The specified MigrationJobState is malformed.

指定的MigrationJobState不合法。

400
InvalidProjectName.Malformed
The specified ProjectName is malformed.

指定的ProjectName不合法。

400
InvalidTagFilterKey.Conflict
The specified TagFilterKey already exists.

指定的过滤标签键已存在。

400
InvalidTagFilterKey.Malformed
The specified TagFilterKey is malformed.

指定的标签键不合法。

400
InvalidTagFilterValue.Malformed
The specified TagFilterValue already exists.

指定的过滤标签值已存在。

400
LimitExceeded.MaximumTagFilterKeys
You've reached the limit on the number of TagFilterKeys that you can set.

指定的标签过滤键超过最大限制。

400
LimitExceeded.MaximumTagFilterResults
You've reached the limit on the number of resources that you can describe by TagFilters.

通过标签过滤出的资源数量超过上限。

400
LimitExceeded.MaximumTagFilterValues
You've reached the limit on the number of TagFilterValues that you can set.

指定的标签过滤值超过最大限制。