AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 服务器迁移中心 开发参考 API参考 API目录 迁移任务 DescribeReplicationJobs - 查询一个或多个迁移任务的详细信息

DescribeReplicationJobs - 查询一个或多个迁移任务的详细信息

更新时间：
产品详情
我的收藏

调用DescribeReplicationJobs查询一个或多个迁移任务的详细信息。

接口说明

接口说明

  • 请求参数的作用类似于一个过滤器，过滤器为逻辑与（AND）关系。如果某一参数为空，则过滤器不起作用。

  • 支持迁移源的迁移目标为 Docker 容器镜像，实现低成本容器化应用迁移。关于 Docker 容器镜像详情请参见容器镜像服务。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

smc:DescribeReplicationJobs

get

*全部资源

*

 无 无

请求参数

名称

类型

必填

描述

示例值
Name

string

否

迁移任务的名称。

testMigrationTaskName
RegionId

string

否

迁移源需迁入的目标阿里云地域 ID。

例如，您需要迁移源服务器至杭州，则 RegionId 为cn-hangzhou。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

cn-hangzhou
Status

string

否

迁移任务的主状态。取值范围：

  • Ready：未开始。

  • Running：运行中。

  • Stopped：已暂停。

  • InError：出错。

  • Finished：已完成。

  • Waiting：等待中。

  • Expired：已过期。

  • Deleting：删除中。

Ready
BusinessStatus

string

否

迁移任务的业务状态。取值范围：

  • Preparing：准备中。

  • Syncing：同步中。

  • Processing：处理中。

  • Cleaning：清理中。

Preparing
PageNumber

integer

否

返回结果中，迁移任务列表的页码。起始值：1。

默认值：1。

1
PageSize

integer

否

分页查询时设置的每页行数。最大值：50。

默认值：10。

10
SourceId

array

否

迁移源 ID 列表。N 的最大值为 50。

s-bp1e2fsl57knvuug****

string

否

迁移源 ID 列表。N 的最大值为 50。

s-bp1bjhkwk2j5hlbn****
JobId

array

否

迁移任务 ID 列表。N 的最大值：50。

j-bp19vlwm0tyigbmj****

string

否

迁移任务 ID 列表。N 的最大值：50。

j-bp1h3d33mekxwu0n****
JobType

integer

否

迁移任务的类型。取值范围：

  • 0：服务器迁移。

  • 1：操作系统迁移。

  • 2：跨可用区迁移。

  • 3：VMware 无代理迁移。

0
InstanceId

array

否

实例 ID。

string

否

目标实例 ID。

i-bp1f1dvfto1sigz5****
ResourceGroupId

string

否

资源组 ID。

rg-acfmw3ty5y7****
Tag

array<object>

否

为 SMC 资源指定的标签。

object

否

为 SMC 资源指定的标签。

Key

string

否

为 SMC 资源指定的标签键。N 的取值范围：1~20。

一旦传入该值，可以为空字符串。最多支持 64 个字符，不能包含 http://或者 https://。

TestKey
Value

string

否

为 SMC 资源指定的标签值。N 的取值范围：1~20。

一旦传入该值，可以为空字符串。最多支持 64 个字符，不能包含 http://或者 https://。

TestValue

返回参数

名称

类型

描述

示例值

object

TotalCount

integer

迁移任务总个数。

5
ReplicationJobs

object

ReplicationJob

array<object>

迁移任务详情的集合。

object

迁移任务详情的集合。

Frequency

integer

增量迁移任务自动执行的时间间隔，单位：小时。取值范围：1~168。

15
VpcId

string

已配置高速通道服务或者 VPN 网关的 VPC ID。

vpc-bp1vwnn14rqpyiczj****
CreationTime

string

迁移任务的创建时间。

2014-07-24T13:00:52Z
Status

string

迁移任务的主状态。可能值：

  • Ready：未开始。

  • Running：运行中。

  • Stopped：已暂停。

  • InError：出错。

  • Finished：已完成。

  • Waiting：等待中。

  • Expired：已过期。

  • Deleting：删除中。

Running
ScheduledStartTime

string

迁移任务的执行时间。按照ISO 8601标准表示，并使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。该参数值的设置需满足以下要求：

  • 该参数值必须晚于当前时间，并且需要设置在 30 天以内。

  • 如果该参数值为空，则 SMC 不会启动迁移任务，需要您调用 StartReplicationJob 启动任务。

2019-06-04T13:35:00Z
MaxNumberOfImageToKeep

integer

增量迁移任务默认保留的最大镜像数。取值范围：1~10。

8
ContainerNamespace

string

Docker 的命名空间。

testNamespace
DataDisks

object

DataDisk

array<object>

目标阿里云服务器 ECS 的数据盘。

object

目标阿里云服务器 ECS 的数据盘。

Index

integer

数据盘顺序。

1
Size

integer

数据盘大小。单位：GiB。

40
Parts

object

Part

array<object>

数据盘分区信息。

object

数据盘分区信息。

SizeBytes

integer

数据盘分区大小。单位：Byte。

21474836480
Block

boolean

分区是否开启块复制。

true
Device

string

数据盘分区设备标识。

0_1
StatusInfo

string

迁移状态的详细信息。

statusinfo
InstanceRamRole

string

实例 RAM 角色名称。

SMCAdmin
SystemDiskSize

integer

目标阿里云服务器 ECS 的系统盘大小。

40
Description

string

迁移任务的描述。

This is my migration task.
ReplicationParameters

string

复制驱动器参数信息。

BandWidthLimit:0
ErrorCode

string

迁移任务的错误码。

InternalError
ValidTime

string

迁移任务的过期时间。按照ISO 8601标准表示，并使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。

说明

+8 小时后是控制台上显示的时间。

2019-06-08T14:40:52Z
NetMode

integer

迁移时使用的网络类型。

0
ContainerTag

string

Docker 的镜像标签。

CentOS:v1
LicenseType

string

迁移任务的许可证类型。可能值：

  • 空值：无许可证。

  • BYOL：自带许可。

BYOL
Name

string

迁移任务名称。

testMigrationTaskName
ImageId

string

迁移任务交付的目标镜像 ID。

m-o6w3gy99qf89rkga****
Progress

number

迁移任务总进度。

100
RunOnce

boolean

区分一次性迁移任务和增量迁移任务。可能值：

  • true：一次性迁移任务。任务创建后仅执行一次。

  • false：增量迁移任务。任务创建后，按照Frequency设置的时间间隔，周期性自动执行。

true
LaunchTemplateId

string

实例启动模板 ID。

lt-launchtemplateid
ContainerRepository

string

Docker 的镜像仓库。

testRepository
InstanceId

string

目标实例 ID。

i-bp1ff25rzvnul6kr****
SystemDiskParts

object

SystemDiskPart

array<object>

系统盘分区信息。

object

系统盘分区信息。

SizeBytes

integer

系统盘分区大小。单位：Byte。

254803968
Block

boolean

系统盘分区是否开启块复制。

true
Device

string

系统盘分区设备标识符。

0_1
InstanceType

string

中转实例的实例规格。

ecs.sn1ne.large
SourceId

string

迁移源 ID。

s-bp1e2fsl57knvuug****
LaunchTemplateVersion

string

一个或多个实例启动模板版本。

1
RegionId

string

迁移源需迁入的目标阿里云地域 ID。

cn-hangzhou
TransitionInstanceId

string

迁移中转实例 ID。

i-bp1ff25rzvnul6kr****
EndTime

string

迁移任务的完成时间。按照ISO 8601标准表示，并使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。

说明

+8 小时后是控制台上显示的时间。

2019-06-04T16:00:52Z
StartTime

string

迁移任务的开始时间。按照ISO 8601标准表示，并使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。

说明

+8 小时后是控制台上显示的时间。

2019-06-04T14:40:52Z
VSwitchId

string

指定 VPC 下的虚拟交换机 ID。

vsw-bp1ddbrxdlrcbim46****
JobId

string

迁移任务 ID。

j-bp19vlwm0tyigbmj****
ImageName

string

迁移任务交付的目标镜像名称。

testAliCloudImageName
BusinessStatus

string

迁移任务的业务状态。可能值：

  • Preparing：准备中。

  • Syncing：同步中。

  • Processing：处理中。

  • Cleaning：清理中。

Preparing
ReplicationJobRuns

object

ReplicationJobRun

array<object>

迁移任务运行记录。

object

迁移任务运行记录。

EndTime

string

迁移任务运行的结束时间。按照ISO 8601标准表示，并使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。

说明

+8 小时后是控制台上显示的时间。

2019-10-04T13:35:00Z
Type

string

迁移任务的执行方式。可能值：

  • Manual：手动执行。

  • Schedule：定时执行或周期执行。

Schedule
StartTime

string

迁移任务运行的开始时间。按照ISO 8601标准表示，并使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。

说明

+8 小时后是控制台上显示的时间。

2019-10-01T13:35:00Z
ImageId

string

迁移任务生成的镜像 ID。

m-o6w3gy99qf89rkga****
TargetType

string

迁移交付的目标类型。可能值：

  • Image：迁移成功后，SMC 为您的迁移源生成阿里云镜像。

  • ContainerImage：迁移成功后，SMC 为您的迁移源生成 Docker 容器镜像。

  • TargetInstance：迁移成功后，SMC 将您的迁移源直接迁移至目标实例。当您设置该参数值时，您需要同时指定 InstanceId 参数。

Image
JobType

integer

迁移任务的类型。可能值：

  • 0：服务器迁移。

  • 1：操作系统迁移。

  • 2：跨可用区迁移。

  • 3：VMware 无代理迁移。

0
ResourceGroupId

string

资源组 ID。

rg-acfmw3ty5y7****
Tags

object

Tag

array<object>

为 SMC 资源指定的标签。

object

为 SMC 资源指定的标签。

Key

string

为 SMC 资源指定的标签键。N 的取值范围：1~20。

一旦传入该值，可以为空字符串。最多支持 64 个字符，不能包含 http://或者 https://。

TestKey
Value

string

为 SMC 资源指定的标签值。N 的取值范围：1~20。

一旦传入该值，可以为空字符串。最多支持 64 个字符，不能包含 http://或者 https://。

TestValue
Disks

object

磁盘信息。

System

object

系统盘信息。

Size

integer

迁移源系统盘的大小，单位：GiB。取值范围为 20~32768。

说明

参数取值需要大于源服务器数据盘实际占用大小。例如，源数据盘大小为 500 GiB，实际占用 100 GiB，则该参数取值需大于 100 GiB。

100
LVM

boolean

是否使用 LVM。可能值：

  • true：使用 LVM。

  • false：不使用 LVM。

false
DiskId

string

系统盘 ID。

d-2zeh4twm100qskw7z41z
Parts

object

Part

array<object>

系统盘分区信息。

object

系统盘分区信息。

SizeBytes

integer

系统盘分区大小。单位：Byte。

21474836480

Block

boolean

系统盘分区是否开启块复制。取值：

  • true：系统盘分区开启块复制。

  • false：系统盘分区不开启块复制。

true
Path

string

系统盘分区路径。

/boot
Data

object

Data

array<object>

数据盘信息。

object

数据盘信息。

Size

integer

目标阿里云服务器 ECS 的数据盘大小，单位为 GiB。取值范围：20~32768。

说明

该参数取值需要大于迁移源数据盘实际占用大小。例如，源数据盘大小为 500 GiB，实际占用 100 GiB，则该参数取值需大于 100 GiB。

22548578304
LVM

boolean

是否使用 LVM。取值：

  • true：使用 LVM。

  • false：不使用 LVM。

false
DiskId

string

数据盘 ID。

d-2zeh4twm100qskw7z41z
Parts

object

Part

array<object>

数据盘分区信息。

object

数据盘分区信息。

SizeBytes

integer

数据盘分区大小。单位：Byte。

21474836480

Block

boolean

数据盘分区是否开启块复制。取值：

  • true：数据盘分区开启块复制。

  • false：数据盘分区不开启块复制。

false
Path

string

数据盘分区路径。

/home/data

WorkgroupId

string

PageSize

integer

每页行数。

10
RequestId

string

请求 ID。

6E1187E8-843A-4850-B97E-2F17F00D48F7
PageNumber

integer

迁移任务列表的页码。

1

示例

正常返回示例

JSON格式

{
  "TotalCount": 5,
  "ReplicationJobs": {
    "ReplicationJob": [
      {
        "Frequency": 15,
        "VpcId": "vpc-bp1vwnn14rqpyiczj****",
        "CreationTime": "2014-07-24T13:00:52Z",
        "Status": "Running",
        "ScheduledStartTime": "2019-06-04T13:35:00Z",
        "MaxNumberOfImageToKeep": 8,
        "ContainerNamespace": "testNamespace",
        "DataDisks": {
          "DataDisk": [
            {
              "Index": 1,
              "Size": 40,
              "Parts": {
                "Part": [
                  {
                    "SizeBytes": 21474836480,
                    "Block": true,
                    "Device": "0_1"
                  }
                ]
              }
            }
          ]
        },
        "StatusInfo": "statusinfo",
        "InstanceRamRole": "SMCAdmin",
        "SystemDiskSize": 40,
        "Description": "This is my migration task.",
        "ReplicationParameters": "BandWidthLimit:0",
        "ErrorCode": "InternalError",
        "ValidTime": "2019-06-08T14:40:52Z",
        "NetMode": 0,
        "ContainerTag": "CentOS:v1",
        "LicenseType": "BYOL",
        "Name": "testMigrationTaskName",
        "ImageId": "m-o6w3gy99qf89rkga****",
        "Progress": 100,
        "RunOnce": true,
        "LaunchTemplateId": "lt-launchtemplateid",
        "ContainerRepository": "testRepository",
        "InstanceId": "i-bp1ff25rzvnul6kr****",
        "SystemDiskParts": {
          "SystemDiskPart": [
            {
              "SizeBytes": 254803968,
              "Block": true,
              "Device": "0_1"
            }
          ]
        },
        "InstanceType": "ecs.sn1ne.large",
        "SourceId": "s-bp1e2fsl57knvuug****",
        "LaunchTemplateVersion": "1",
        "RegionId": "cn-hangzhou",
        "TransitionInstanceId": "i-bp1ff25rzvnul6kr****",
        "EndTime": "2019-06-04T16:00:52Z",
        "StartTime": "2019-06-04T14:40:52Z",
        "VSwitchId": "vsw-bp1ddbrxdlrcbim46****",
        "JobId": "j-bp19vlwm0tyigbmj****",
        "ImageName": "testAliCloudImageName",
        "BusinessStatus": "Preparing",
        "ReplicationJobRuns": {
          "ReplicationJobRun": [
            {
              "EndTime": "2019-10-04T13:35:00Z",
              "Type": "Schedule",
              "StartTime": "2019-10-01T13:35:00Z",
              "ImageId": "m-o6w3gy99qf89rkga****"
            }
          ]
        },
        "TargetType": "Image",
        "JobType": 0,
        "ResourceGroupId": "rg-acfmw3ty5y7****",
        "Tags": {
          "Tag": [
            {
              "Key": "TestKey",
              "Value": "TestValue"
            }
          ]
        },
        "Disks": {
          "System": {
            "Size": 100,
            "LVM": false,
            "DiskId": "d-2zeh4twm100qskw7z41z",
            "Parts": {
              "Part": [
                {
                  "SizeBytes": 21474836480,
                  "Block": true,
                  "Path": "/boot"
                }
              ]
            }
          },
          "Data": {
            "Data": [
              {
                "Size": 22548578304,
                "LVM": false,
                "DiskId": "d-2zeh4twm100qskw7z41z",
                "Parts": {
                  "Part": [
                    {
                      "SizeBytes": 21474836480,
                      "Block": false,
                      "Path": "/home/data\n"
                    }
                  ]
                }
              }
            ]
          }
        },
        "WorkgroupId": ""
      }
    ]
  },
  "PageSize": 10,
  "RequestId": "6E1187E8-843A-4850-B97E-2F17F00D48F7",
  "PageNumber": 1
}

错误码

HTTP status code

错误码

错误信息

描述
500 InternalError An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket. 内部错误，请重试。如果多次尝试失败，请提交工单。
403 Forbidden.Unauthorized A required authorization for the specified action is not supplied. 用户未授权操作指定的资源。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。

上一篇：StopReplicationJob - 停止一个迁移任务下一篇：CutOverReplicationJob - 停止周期执行自动增量任务