All Products
Search
Document Center

Server Migration Center:DescribeReplicationJobs

Last Updated:Mar 03, 2024

Queries the details of migration jobs.

Operation description

Usage notes

  • You can specify multiple request parameters to be queried. Specified parameters are evaluated by using the AND operator. Only the specified parameters are used as filter conditions.
  • Server Migration Center (SMC) allows you to migrate source servers to Docker container images. You can use SMC to migrate containerized applications in a cost-effective way. For more information, see Terms .

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
NamestringNo

The name of the migration job.

testMigrationTaskName
RegionIdstringNo

The ID of the Alibaba Cloud region to which you want to migrate the source server.

For example, if you want to migrate a source server to the China (Hangzhou) region, set this parameter to cn-hangzhou. You can call the DescribeRegions operation to query the latest regions.

cn-hangzhou
StatusstringNo

The status of the migration job. Valid values:

  • Ready: The migration job is not started.
  • Running: The migration job is running.
  • Stopped: The migration job is paused.
  • InError: An error occurs in the migration job.
  • Finished: The migration job is complete.
  • Waiting: The migration job is waiting to run.
  • Expired: The migration job has expired.
  • Deleting: The migration job is being deleted.
Ready
BusinessStatusstringNo

The business status of the migration job. Valid values:

  • Preparing: The migration is being prepared.
  • Syncing: Data is being synchronized.
  • Processing: The migration is in progress.
  • Cleaning: Intermediate resources are being released.
Preparing
PageNumberintegerNo

The number of the page to return. Pages start from page 1.

Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page. Valid values: 1 to 50.

Default value: 10.

10
SourceIdarrayNo

The IDs of the source servers. You can specify a maximum of 50 IDs.

stringNo

The ID of the source server.

s-bp1bjhkwk2j5hlbn****
JobIdarrayNo

The IDs of the migration jobs. You can specify a maximum of 50 IDs.

stringNo

The ID of the migration job.

j-bp1h3d33mekxwu0n****
JobTypeintegerNo

The type of the migration job. Valid values:

  • 0: server migration.
  • 1: operating system migration.
  • 2: cross-zone migration.
  • 3: agentless migration for a VMware VM.
0
InstanceIdarrayNo

The IDs of the destination Elastic Compute Service (ECS) instances.

stringNo

The ID of the destination ECS instance.

i-bp1f1dvfto1sigz5****
ResourceGroupIdstringNo

The ID of the resource group.

rg-acfmw3ty5y7****
Tagobject []No

The information about tags that are attached to the SMC resource.

KeystringNo

The key of the tag N that is added to the SMC resource. Valid values of N: 1 to 20.

The tag key can be an empty string. It can be up to 64 characters in length and cannot contain http:// or https://.

TestKey
ValuestringNo

The value of tag N that is added to the SMC resource. Valid values of N: 1 to 20.

The tag value can be an empty string. It can be up to 64 characters in length and cannot contain http:// or https://.

TestValue

Response parameters

ParameterTypeDescriptionExample
object
TotalCountinteger

The total number of migration jobs returned.

5
ReplicationJobsobject []

The details of migration jobs.

Frequencyinteger

The interval at which the incremental migration job runs. Unit: hour. Valid values: 1 to 168.

15
VpcIdstring

The ID of a virtual private cloud (VPC) for which you have configured an Express Connect circuit or a VPN gateway.

vpc-bp1vwnn14rqpyiczj****
CreationTimestring

The time when the migration job was created.

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

The status of the migration job. Valid values:

  • Ready: The migration job is not started.
  • Running: The migration job is running.
  • Stopped: The migration job is paused.
  • InError: An error occurs in the migration job.
  • Finished: The migration job is complete.
  • Waiting: The migration job is waiting to run.
  • Expired: The migration job has expired.
  • Deleting: The migration job is being deleted.
Running
ScheduledStartTimestring

The time when the migration job is scheduled to run. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. The time must meet the following requirements:

  • The value must be within 30 days after the current time.
  • If you do not specify this parameter, you must manually start the migration job after the migration job is created. You can call the StartReplicationJob operation to start the migration job.
2019-06-04T13:35:00Z
MaxNumberOfImageToKeepinteger

The maximum number of images retained for the incremental migration job. Valid values: 1 to 10.

8
ContainerNamespacestring

The namespace of the destination Docker container image.

testNamespace
DataDisksobject []

The data disks on the destination ECS instance.

Indexinteger

The index number of the data disk.

1
Sizeinteger

The size of the data disk. Unit: GiB.

40
Partsobject []

The data disk partitions.

SizeByteslong

The size of the data disk partition. Unit: bytes.

21474836480
Blockboolean

Indicates whether block replication is enabled for the data disk partition.

true
Devicestring

The device ID of the data disk partition.

0_1
StatusInfostring

The status information about the migration job.

statusinfo
InstanceRamRolestring

The name of the Resource Access Management (RAM) role that is assigned to the instance.

SMCAdmin
SystemDiskSizeinteger

The size of the system disk of the destination ECS instance.

40
Descriptionstring

The description of the migration job.

This is my migration task.
ReplicationParametersstring

The string of key-value pairs configured for the replication driver.

BandWidthLimit:0
ErrorCodestring

The error code returned if an error occurred in the migration job.

InternalError
ValidTimestring

The time when the migration job expired. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

Note The time displayed in the SMC console is in the format of UTC+8.
2019-06-08T14:40:52Z
NetModeinteger

The type of network used for the migration.

0
ContainerTagstring

The tag of the destination Docker container image.

CentOS:v1
LicenseTypestring

The type of license for the migration job. Valid values:

  • An empty value indicates no license.
  • A value of BYOL indicates Bring Your Own License (BYOL).
BYOL
Namestring

The name of the migration job.

testMigrationTaskName
ImageIdstring

The ID of the destination image.

m-o6w3gy99qf89rkga****
Progressfloat

The progress of the migration job.

100
RunOnceboolean

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

  • true: Incremental migration is disabled. A migration job runs only once after the job is created.
  • false: Incremental migration is enabled. For an incremental migration job, SMC synchronizes incremental data to Alibaba Cloud at the interval specified by the Frequency parameter.
true
LaunchTemplateIdstring

The ID of the launch template.

lt-launchtemplateid
ContainerRepositorystring

The repository that stores the destination Docker container image.

testRepository
InstanceIdstring

The ID of the destination ECS instance.

i-bp1ff25rzvnul6kr****
SystemDiskPartsobject []

The system disk partitions.

SizeByteslong

The size of the system disk partition. Unit: bytes.

254803968
Blockboolean

Indicates whether block replication is enabled for the system disk partition.

true
Devicestring

The device ID of the system disk partition.

0_1
InstanceTypestring

The instance type of the intermediate instance.

ecs.sn1ne.large
SourceIdstring

The ID of the source server.

s-bp1e2fsl57knvuug****
LaunchTemplateVersionstring

The versions of the launch template.

1
RegionIdstring

The ID of the Alibaba Cloud region to which the source server is migrated.

cn-hangzhou
TransitionInstanceIdstring

The ID of the intermediate instance.

i-bp1ff25rzvnul6kr****
EndTimestring

The time when the migration job was complete. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

Note The time displayed in the SMC console is in the format of UTC+8.
2019-06-04T16:00:52Z
StartTimestring

The time when the migration job was started. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

Note The time displayed in the SMC console is in the format of UTC+8.
2019-06-04T14:40:52Z
VSwitchIdstring

The ID of the vSwitch in the specified VPC.

vsw-bp1ddbrxdlrcbim46****
JobIdstring

The ID of the migration job.

j-bp19vlwm0tyigbmj****
ImageNamestring

The name of the destination image.

testAliCloudImageName
BusinessStatusstring

The business status of the migration job. Valid values:

  • Preparing: The migration is being prepared.
  • Syncing: Data is being synchronized.
  • Processing: The migration is in progress.
  • Cleaning: Intermediate resources are being released.
Preparing
ReplicationJobRunsobject []

The execution records of the migration job.

EndTimestring

The time when the migration job ended. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

Note The time displayed in the SMC console is in the format of UTC+8.
2019-10-04T13:35:00Z
Typestring

The method used to run the migration job. Valid values:

  • Manual: The migration job was manually started.
  • Schedule: The migration job was started at a scheduled time or at a specific interval.
Schedule
StartTimestring

The time when the migration job was started. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

Note The time displayed in the SMC console is in the format of UTC+8.
2019-10-01T13:35:00Z
ImageIdstring

The ID of the destination image.

m-o6w3gy99qf89rkga****
TargetTypestring

The type of destination to which the source server is migrated. Valid values:

  • Image: After the migration job is complete, SMC generates an ECS image for the source server.
  • ContainerImage: After the migration job is complete, SMC generates a Docker container image for the source server.
  • TargetInstance: After the migration job is complete, SMC migrates the source server to the destination instance. If you set this parameter to TargetInstance, you must set the InstanceId parameter.
Image
JobTypeinteger

The type of the migration job. Valid values:

  • 0: server migration.
  • 1: operating system migration.
  • 2: cross-zone migration.
  • 3: agentless migration for a VMware VM.
0
ResourceGroupIdstring

The ID of the resource group.

rg-acfmw3ty5y7****
Tagsobject []

The information about tags that are attached to the SMC resource.

Keystring

The key of the tag N that is added to the SMC resource. Valid values of N: 1 to 20.

The tag key can be an empty string. It can be up to 64 characters in length and cannot contain http:// or https://.

TestKey
Valuestring

The value of tag N that is added to the SMC resource. Valid values of N: 1 to 20.

The tag value can be an empty string. It can be up to 64 characters in length and cannot contain http:// or https://.

TestValue
PageSizeinteger

The number of entries returned on each page.

10
RequestIdstring

The request ID.

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

The page number of the returned page.

1

Examples

Sample success responses

JSONformat

{
  "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"
            }
          ]
        }
      }
    ]
  },
  "PageSize": 10,
  "RequestId": "6E1187E8-843A-4850-B97E-2F17F00D48F7",
  "PageNumber": 1
}

Error codes

HTTP status codeError codeError messageDescription
403Forbidden.UnauthorizedA required authorization for the specified action is not supplied.-
500InternalErrorAn error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-07-28The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 403
    delete Error Codes: 500