You can call this operation to query the details of one or more migration tasks.

Notes

  • You can specify multiple request parameters. The parameters that you specify have logical AND relations. If you leave a parameter empty, this parameter is not included in the conditions to filter query results.
  • You can migrate source servers to Docker container images. SMC allows you to migrate containerized applications to Container Registry at low costs. For more information about Docker container images, see Container Registry.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeReplicationJobs

The operation that you want to perform. Set the value to DescribeReplicationJobs.

SourceId.N RepeatList No s-bp1e2fsl57knvuug****

The ID of a source server. You can specify a maximum of 50 source server IDs each time.

JobId.N RepeatList No j-bp19vlwm0tyigbmj****

The ID of a migration task. You can specify a maximum of 50 migration task IDs at a time.

Name String No MyMigrationTask

The name of a migration task.

RegionId String No cn-hangzhou

The ID of a destination Alibaba Cloud region.

For example, if you want to query migration tasks in which the destination Alibaba Cloud region is Shanghai, set the value to cn-shanghai. You can call DescribeRegionsto query the latest list of Alibaba Cloud regions.

Status String No Ready

The status of a migration task. Valid values:

  • Ready
  • Running
  • Stopped
  • InError
  • Finished
  • Waiting
  • Expired
  • Deleting
BusinessStatus String No Preparing

The business status of a migration task. Valid values:

  • Preparing
  • Syncing
  • Processing
  • Cleaning
PageNumber Integer No 1

The number of the page to return. Page numbers start from 1.

Default value: 1.

PageSize Integer No 10

The number of entries to return on each page. Maximum value: 50.

Default value: 10.

Response parameters

Parameter Type Example Description
PageNumber Integer 1

The number of the page returned.

PageSize Integer 10

The number of entries returned on each page.

ReplicationJobs Array

A list of migration tasks.

ReplicationJob
BusinessStatus String Preparing

The business status of a migration task.

ContainerNamespace String testNamespace

The namespace of a Docker container image.

ContainerRepository String testRepository

The repository that stores a Docker container image.

ContainerTag String CentOS:v1

The tag of a Docker container image.

CreationTime String 2014-07-24T13:00:52Z

The time when a migration task was created.

DataDisks Array

A list of data disks on a destination ECS instance.

DataDisk
Index Integer 1

The serial number of a destination data disk.

Parts Array

A list of partitions in a data disk.

Part
Block Boolean true

Indicates whether block replication is enabled for a partition in a destination data disk.

Device String 0_1

The ID of a partition in a destination data disk.

SizeBytes Long 21474836480

The size of a partition in a destination data disk. Unit: bytes.

Size Integer 40

The size of a destination data disk. Unit: GiB.

Description String This is my migration task.

The description of a migration task.

EndTime String 2019-06-04T16:00:52Z

The time when a migration task was completed.

ErrorCode String InternalError

The error code returned during a migration task.

Frequency Integer 15

The interval at which SMC automatically synchronizes incremental data to Alibaba Cloud. Unit: hours. Valid values: 1 to 168.

ImageId String m-o6w3gy99qf89rkga****

The ID of a destination image.

ImageName String MyAliCloudImage

The name of a destination image.

InstanceId String i-bp1ff25rzvnul6kr****

The ID of a destination ECS instance.

InstanceRamRole String SMCAdmin

The RAM role that is attached to an intermediate instance.

InstanceType String ecs.sn1ne.large

The type of an intermediate instance.

JobId String j-bp19vlwm0tyigbmj****

The ID of a migration task.

LaunchTemplateId String lt-launchtemplateid

The ID of a launch template for creating destination ECS instances.

LaunchTemplateVersion String 1

The versions of a launch template for creating destination ECS instances.

MaxNumberOfImageToKeep Integer 8

The maximum number of images that can be retained during incremental migration. Valid values: 1 to 10.

Name String MyMigrationTask

The name of a migration task.

NetMode Integer 0

The network mode used for data transmission.

Progress Float 55.45

The overall progress of a migration task.

RegionId String cn-hangzhou

The ID of a destination Alibaba Cloud region.

ReplicationJobRuns Array

A list of the logs of migration tasks.

ReplicationJobRun
EndTime String 2019-10-04T13:35:00Z

The time when a migration task was complete.

ImageId String m-o6w3gy99qf89rkga****

The ID of a destination image.

StartTime String 2019-10-01T13:35:00Z

The time when a migration task was started.

Type String Schedule

The execution mode of a migration task. Valid values:

  • Manual: A migration task is manually started.
  • Schedule: A migration task is automatically started at a scheduled point in time or at a specified interval.
ReplicationParameters String BandWidthLimit:0

A string of key-value pairs for configuring a replication driver.

RunOnce Boolean true

Indicates whether incremental migration is disabled for a source server. Valid values:

  • true: Incremental migration is disabled. Incremental data of a source server is not synchronized.
  • false: Incremental migration is enabled. SMC automatically synchronizes incremental data to Alibaba Cloud at a specified Frequency.
ScheduledStartTime String 2019-06-04T13:35:00Z

The scheduled start time of a migration task.

SourceId String s-bp1e2fsl57knvuug****

The ID of a source server.

StartTime String 2019-06-04T14:40:52Z

The time when a migration task is started.

Status String Running

The status of a migration task.

StatusInfo String statusinfo

The detailed status information of a migration task.

SystemDiskParts Array

The partitioning information of a destination system disk.

SystemDiskPart
Block Boolean true

Indicates whether block replication is enabled for a partition in a destination system disk.

Device String 0_1

The ID of a partition in a destination system disk.

SizeBytes Long 254803968

The size of a partition in a destination system disk. Unit: bytes.

SystemDiskSize Integer 40

The system disk size of a destination ECS instance.

TargetType String image

The type of the destination image.

TransitionInstanceId String i-bp1ff25rzvnul6kr****

The ID of an intermediate instance.

VSwitchId String vsw-bp1ddbrxdlrcbim46****

The ID of a VSwitch in a specified virtual private cloud (VPC).

ValidTime String 2019-06-08T14:40:52Z

The time when a migration task expires.

VpcId String vpc-bp1vwnn14rqpyiczj****

The ID of a VPC that has Express Connect or VPN Gateway configured.

RequestId String 6E1187E8-843A-4850-B97E-2F17F00D48F7

The ID of the request.

TotalCount Integer 5

The total number of migration tasks.

Examples

Sample requests

http(s)://smc.aliyuncs.com/?Action=DescribeReplicationJobs
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

<DescribeReplicationJobsResponse>
      <TotalCount>1</TotalCount>
      <ReplicationJobs>
            <ReplicationJob>
                  <Status>Running</Status>
                  <Progress>75</Progress>
                  <TransitionInstanceId>i-bp1ff25rzvnul6kr****</TransitionInstanceId>
                  <DataDisks>
                        <DataDisk>
                              <Parts>
                                    <Part>
                                          <Device>2_0</Device>
                                          <Block>true</Block>
                                          <SizeBytes>5334102016</SizeBytes>
                                    </Part>
                              </Parts>
                              <Size>20</Size>
                              <Index>2</Index>
                        </DataDisk>
                  </DataDisks>
                  <SystemDiskSize>20</SystemDiskSize>
                  <NetMode>0</NetMode>
                  <SourceId>s-bp1e2fsl57knvuug****</SourceId>
                  <SystemDiskParts>
                        <SystemDiskPart>
                              <Device>0_0</Device>
                              <Block>true</Block>
                              <SizeBytes>21466120192</SizeBytes>
                        </SystemDiskPart>
                  </SystemDiskParts>
                  <StartTime>2020-05-14T12:01:24Z</StartTime>
                  <BusinessStatus>Processing</BusinessStatus>
                  <Name>MyMigrationTask</Name>
                  <ValidTime>2020-06-13T12:01:24Z</ValidTime>
                  <RunOnce>true</RunOnce>
                  <TargetType>Image</TargetType>
                  <CreationTime>2020-05-14T12:01:24Z</CreationTime>
                  <RegionId>cn-hangzhou</RegionId>
                  <ErrorCode></ErrorCode>
                  <JobId>j-bp19vlwm0tyigbmj****</JobId>
            </ReplicationJob>
      </ReplicationJobs>
      <RequestId>6E1187E8-843A-4850-B97E-2F17F00D48F7</RequestId>
      <PageSize>10</PageSize>
      <PageNumber>1</PageNumber>
</DescribeReplicationJobsResponse>

JSON format

{
  "TotalCount": 1,
  "ReplicationJobs": {
    "ReplicationJob": [
      {
        "Status": "Running",
        "Progress": 75.0,
        "TransitionInstanceId": "i-bp1ff25rzvnul6kr****",
        "DataDisks": {
          "DataDisk": [
            {
              "Parts": {
                "Part": [
                  {
                    "Device": "2_0",
                    "Block": true,
                    "SizeBytes": 5334102016
                  }
                ]
              },
              "Size": 20,
              "Index": 2
            }
          ]
        },
        "SystemDiskSize": 20,
        "NetMode": 0,
        "SourceId": "s-bp1e2fsl57knvuug****",
        "SystemDiskParts": {
          "SystemDiskPart": [
            {
              "Device": "0_0",
              "Block": true,
              "SizeBytes": 21466120192
            }
          ]
        },
        "StartTime": "2020-05-14T12:01:24Z",
        "BusinessStatus": "Processing",
        "Name": "MyMigrationTask",
        "ValidTime": "2020-06-13T12:01:24Z",
        "RunOnce": true,
        "TargetType": "Image",
        "CreationTime": "2020-05-14T12:01:24Z",
        "RegionId": "cn-hangzhou",
        "ErrorCode": "",
        "JobId": "j-bp19vlwm0tyigbmj****"
      }
    ]
  },
  "RequestId": "6E1187E8-843A-4850-B97E-2F17F00D48F7",
  "PageSize": 10,
  "PageNumber": 1
}

Error codes

For a list of error codes, visit the API Error Center.