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
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| smc:DescribeReplicationJobs | get |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| Name | string | No | The name of the migration job. | testMigrationTaskName |
| RegionId | string | No | 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 |
| Status | string | No | The status of the migration job. Valid values:
| Ready |
| BusinessStatus | string | No | The business status of the migration job. Valid values:
| Preparing |
| PageNumber | integer | No | The number of the page to return. Pages start from page 1. Default value: 1. | 1 |
| PageSize | integer | No | The number of entries to return on each page. Valid values: 1 to 50. Default value: 10. | 10 |
| SourceId | array | No | The IDs of the source servers. You can specify a maximum of 50 IDs. | |
| string | No | The ID of the source server. | s-bp1bjhkwk2j5hlbn**** | |
| JobId | array | No | The IDs of the migration jobs. You can specify a maximum of 50 IDs. | |
| string | No | The ID of the migration job. | j-bp1h3d33mekxwu0n**** | |
| JobType | integer | No | The type of the migration job. Valid values:
| 0 |
| InstanceId | array | No | The IDs of the destination Elastic Compute Service (ECS) instances. | |
| string | No | The ID of the destination ECS instance. | i-bp1f1dvfto1sigz5**** | |
| ResourceGroupId | string | No | The ID of the resource group. | rg-acfmw3ty5y7**** |
| Tag | array<object> | No | The information about tags that are attached to the SMC resource. | |
| object | No | The tags list. | ||
| Key | string | No | 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 |
| Value | string | No | TestValue |
Response parameters
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"
}
]
},
"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"
}
]
}
}
]
}
}
}
]
},
"PageSize": 10,
"RequestId": "6E1187E8-843A-4850-B97E-2F17F00D48F7",
"PageNumber": 1
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 403 | Forbidden.Unauthorized | A required authorization for the specified action is not supplied. | - |
| 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. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-09-27 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2023-07-28 | The Error code has changed | View Change Details |