DescribeReplicationJobs - Server Migration Center - Alibaba Cloud Documentation Center

Retrieves details about one or more migration tasks.

Operation description

API Operations

Request parameters are used as filters and are combined using a logical AND. If you do not specify a parameter, the corresponding filter is not applied.
You can migrate a source to a Docker container image for low-cost application containerization. For more information about Docker container images, see Container Registry.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

smc:DescribeReplicationJobs

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Name	string	No	The name of the migration task.	testMigrationTaskName
RegionId	string	No	The ID of the destination Alibaba Cloud region to which you want to migrate the source. For example, if you want to migrate a source server to the China (Hangzhou) region, set RegionId to `cn-hangzhou`. You can call DescribeRegions to view the latest list of Alibaba Cloud regions.	cn-hangzhou
Status	string	No	The main status of the migration task. Valid values: Ready: The task is not started. Running: The task is running. Stopped: The task is paused. InError: An error occurred. Finished: The task is complete. Waiting: The task is waiting. Expired: The task has expired. Deleting: The task is being deleted.	Ready
BusinessStatus	string	No	The business status of the migration task. Valid values: Preparing: The task is being prepared. Syncing: Data is being synchronized. Processing: The task is being processed. Cleaning: The task is being cleared.	Preparing
PageNumber	integer	No	The page number of the migration task list. The value starts from 1. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page for a paged query. Maximum value: 50. Default value: 10.	10
SourceId	array	No	The IDs of the migration sources. You can specify up to 50 migration source IDs.	s-bp1e2fsl57knvuug****
	string	No	The IDs of the migration sources. You can specify up to 50 migration source IDs.	s-bp1bjhkwk2j5hlbn****
JobId	array	No	The IDs of the migration tasks. You can specify up to 50 migration task IDs.	j-bp19vlwm0tyigbmj****
	string	No	The IDs of the migration tasks. You can specify up to 50 migration task IDs.	j-bp1h3d33mekxwu0n****
JobType	integer	No	The type of the migration task. Valid values: 0: server migration. 1: operating system migration. 2: cross-zone migration. 3: agentless VMware migration.	0
InstanceId	array	No	The instance ID.
	string	No	The ID of the destination instance.	i-bp1f1dvfto1sigz5****
ResourceGroupId	string	No	The ID of the resource group.	rg-acfmw3ty5y7****
Tag	array<object>	No	The tags of the SMC resource.
	object	No	The tags of the SMC resource.
Key	string	No	The key of tag N that is specified for the SMC resource. Valid values of N: 1 to 20. This parameter can be an empty string. The tag key can be up to 64 characters in length and cannot contain http:// or https://.	TestKey
Value	string	No	The value of tag N that is specified for the SMC resource. Valid values of N: 1 to 20. This parameter can be an empty string. The tag value can be up to 64 characters in length and cannot contain http:// or https://.	TestValue

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of migration tasks.	5
ReplicationJobs	object
ReplicationJob	array<object>	A collection of migration task details.
	object	A collection of migration task details.
Frequency	integer	The interval at which an incremental migration task is automatically run. Unit: hours. Valid values: 1 to 168.	15
VpcId	string	The ID of the VPC for which an Express Connect circuit or a VPN Gateway is configured.	vpc-bp1vwnn14rqpyiczj****
CreationTime	string	The time when the migration task was created.	2014-07-24T13:00:52Z
Status	string	The main status of the migration task. Valid values: Ready: The task is not started. Running: The task is running. Stopped: The task is paused. InError: An error occurred. Finished: The task is complete. Waiting: The task is waiting. Expired: The task has expired. Deleting: The task is being deleted.	Running
ScheduledStartTime	string	The time when the migration task is scheduled to run. The time is specified in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. This parameter must meet the following requirements: The time must be later than the current time and within 30 days from the current time. If you leave this parameter empty, SMC does not start the migration task. In this case, you must call the StartReplicationJob operation to start the task.	2019-06-04T13:35:00Z
MaxNumberOfImageToKeep	integer	The maximum number of images that can be retained for an incremental migration task. Valid values: 1 to 10.	8
ContainerNamespace	string	The namespace of the Docker container.	testNamespace
DataDisks	object
DataDisk	array<object>	The data disks of the destination Alibaba Cloud Elastic Compute Service (ECS) instance.
	object	The data disks of the destination Alibaba Cloud ECS instance.
Index	integer	The index number of the data disk.	1
Size	integer	The size of the data disk. Unit: GiB.	40
Parts	object
Part	array<object>	The information about the data disk partitions.
	object	The information about the data disk partitions.
SizeBytes	integer	The size of the data disk partition. Unit: bytes.	21474836480
Block	boolean	Indicates whether block replication is enabled for the partition.	true
Device	string	The device ID of the data disk partition.	0_1
StatusInfo	string	The details of the migration status.	statusinfo
InstanceRamRole	string	The name of the instance RAM role.	SMCAdmin
SystemDiskSize	integer	The size of the system disk of the destination Alibaba Cloud ECS instance.	40
Description	string	The description of the migration task.	This is my migration task.
ReplicationParameters	string	The parameters of the replication driver.	BandWidthLimit:0
ErrorCode	string	The error code of the migration task.	InternalError
ValidTime	string	The time when the migration task expires. The time is specified in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Note The time displayed in the console is in the UTC+8 time zone.	2019-06-08T14:40:52Z
NetMode	integer	The network mode used for the migration.	0
ContainerTag	string	The tag of the Docker image.	CentOS:v1
LicenseType	string	The license type of the migration task. Valid values: An empty value indicates no license. BYOL: Bring Your Own License.	BYOL
Name	string	The name of the migration task.	testMigrationTaskName
ImageId	string	The ID of the destination image that is created from the migration task.	m-o6w3gy99qf89rkga****
Progress	number	The overall progress of the migration task.	100
RunOnce	boolean	Indicates whether the task is a one-time or incremental migration task. Valid values: true: The task is a one-time migration task. The task is run only once after it is created. false: The task is an incremental migration task. After the task is created, it is automatically run at the interval specified by the `Frequency` parameter.	true
LaunchTemplateId	string	The ID of the launch template.	lt-launchtemplateid
ContainerRepository	string	The Docker image repository.	testRepository
InstanceId	string	The ID of the destination instance.	i-bp1ff25rzvnul6kr****
SystemDiskParts	object
SystemDiskPart	array<object>	The information about the system disk partitions.
	object	The information about the system disk partitions.
SizeBytes	integer	The size of the system disk partition. Unit: bytes.	254803968
Block	boolean	Indicates whether block replication is enabled for the system disk partition.	true
Device	string	The device ID of the system disk partition.	0_1
InstanceType	string	The instance type of the intermediate instance.	ecs.sn1ne.large
SourceId	string	The ID of the migration source.	s-bp1e2fsl57knvuug****
LaunchTemplateVersion	string	The version of the launch template.	1
RegionId	string	The ID of the destination Alibaba Cloud region to which you want to migrate the source.	cn-hangzhou
TransitionInstanceId	string	The ID of the intermediate instance.	i-bp1ff25rzvnul6kr****
EndTime	string	The time when the migration task was completed. The time is specified in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Note The time displayed in the console is in the UTC+8 time zone.	2019-06-04T16:00:52Z
StartTime	string	The time when the migration task started. The time is specified in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Note The time displayed in the console is in the UTC+8 time zone.	2019-06-04T14:40:52Z
VSwitchId	string	The ID of the vSwitch in the specified VPC.	vsw-bp1ddbrxdlrcbim46****
JobId	string	The ID of the migration task.	j-bp19vlwm0tyigbmj****
ImageName	string	The name of the destination image that is created from the migration task.	testAliCloudImageName
BusinessStatus	string	The business status of the migration task. Valid values: Preparing: The task is being prepared. Syncing: Data is being synchronized. Processing: The task is being processed. Cleaning: The task is being cleared.	Preparing
ReplicationJobRuns	object
ReplicationJobRun	array<object>	The running records of the migration task.
	object	The running records of the migration task.
EndTime	string	The time when the migration task run ended. The time is specified in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Note The time displayed in the console is in the UTC+8 time zone.	2019-10-04T13:35:00Z
Type	string	The execution mode of the migration task. Valid values: Manual: The task is manually run. Schedule: The task is run at a scheduled time or at a specific interval.	Schedule
StartTime	string	The time when the migration task run started. The time is specified in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Note The time displayed in the console is in the UTC+8 time zone.	2019-10-01T13:35:00Z
ImageId	string	The ID of the image generated by the migration task.	m-o6w3gy99qf89rkga****
TargetType	string	The type of the migration destination. Valid values: Image: After the migration is complete, SMC generates an Alibaba Cloud image for the migration source. ContainerImage: After the migration is complete, SMC generates a Docker container image for the migration source. TargetInstance: After the migration is complete, SMC migrates the migration source to a destination instance. If you set the value to TargetInstance, you must also specify the InstanceId parameter.	Image
JobType	integer	The type of the migration task. Valid values: 0: server migration. 1: operating system migration. 2: cross-zone migration. 3: agentless VMware migration.	0
ResourceGroupId	string	The ID of the resource group.	rg-acfmw3ty5y7****
Tags	object
Tag	array<object>	The tags of the SMC resource.
	object	The tags of the SMC resource.
Key	string	The key of tag N that is specified for the SMC resource. Valid values of N: 1 to 20. This parameter can be an empty string. The tag key can be up to 64 characters in length and cannot contain http:// or https://.	TestKey
Value	string	The value of tag N that is specified for the SMC resource. Valid values of N: 1 to 20. This parameter can be an empty string. The tag value can be up to 64 characters in length and cannot contain http:// or https://.	TestValue
Disks	object	The disk information.
System	object	The system disk information.
Size	integer	The size of the source system disk. Unit: GiB. Valid values: 20 to 32768. Note The value of this parameter must be greater than the used space of the source system disk. For example, if the source system disk is 500 GiB in size and 100 GiB of the space is used, the value of this parameter must be greater than 100.	100
LVM	boolean	Indicates whether LVM is used. Valid values: true: LVM is used. false: LVM is not used.	false
DiskId	string	The system disk ID.	d-2zeh4twm100qskw7z41z
Parts	object
Part	array<object>	The system disk partition information.
	object	The system disk partition information.
SizeBytes	integer	The size of the system disk partition. Unit: bytes.	21474836480
Block	boolean	Indicates whether to enable block replication for the system disk partition. Valid values: true: Block replication is enabled for the system disk partition. false: Block replication is not enabled for the system disk partition.	true
Path	string	The path of the system disk partition.	/boot
Data	object
Data	array<object>	The data disk information.
	object	The data disk information.
Size	integer	The size of the data disk of the destination Alibaba Cloud ECS instance. Unit: GiB. Valid values: 20 to 32768. Note The value of this parameter must be greater than the used space of the source data disk. For example, if the source data disk is 500 GiB in size and 100 GiB of the space is used, the value of this parameter must be greater than 100.	22548578304
LVM	boolean	Indicates whether LVM is used. Valid values: true: LVM is used. false: LVM is not used.	false
DiskId	string	The data disk ID.	d-2zeh4twm100qskw7z41z
Parts	object
Part	array<object>	The data disk partition information.
	object	The data disk partition information.
SizeBytes	integer	The size of the data disk partition. Unit: bytes.	21474836480
Block	boolean	Indicates whether to enable block replication for the data disk partition. Valid values: true: Block replication is enabled for the data disk partition. false: Block replication is not enabled for the data disk partition.	false
Path	string	The path of the data disk partition.	/home/data
WorkgroupId	string	The ID of the workgroup.	w-bp1ja22kdqphehlj****
PageSize	integer	The number of entries per page.	10
RequestId	string	The request ID.	6E1187E8-843A-4850-B97E-2F17F00D48F7
PageNumber	integer	The page number of the migration task list.	1

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	An 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.
403	Forbidden.Unauthorized	A required authorization for the specified action is not supplied.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.