Queries the information about migration sources.
Operation description
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:DescribeSourceServers | get |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| JobId | string | No | The migration job ID. | j-bp19vlwm0tyigbmj**** |
| State | string | No | The state of the migration source. Valid Values:
| Available |
| Name | string | No | The name of the migration source. The name must be 2 to 128 characters in length. It must start with a letter and cannot start with http:// or https://. It can contain digits, colons (:), underscores (_), and hyphens (-). Default value: null. | testSourceServerName |
| PageNumber | integer | No | The page number. Pages start from page 1. Default value: 1. | 1 |
| PageSize | integer | No | The number of entries per page. Valid values: 1 to 50. Default value: 10 | 10 |
| SourceId | array | No | The migration source IDs. You can specify multiple IDs. | |
| string | No | The migration source ID. You can specify multiple IDs. | s-bp1e2fsl57knvuug**** | |
| ResourceGroupId | string | No | The ID of the resource group. | rg-acfmw3ty5y7**** |
| Tag | array<object> | No | The tag. | |
| object | No | The tag list. | ||
| Key | string | No | The key of tag N that is added to the SMC resource. Valid values of N: 1 to 20. The tag key cannot be an empty string. It can be up to 64 characters in length and cannot start with acs: or aliyun. It cannot contain http:// or https://. | TestKey |
| Value | string | No | 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 |
| RelatedJobType | array | No | The types of migration jobs that are associated with migration sources. | |
| string | No | The type of migration job that is associated with the migration source. Valid values:
| Server |
Response parameters
Examples
Sample success responses
JSONformat
{
"SourceServers": {
"SourceServer": [
{
"CreationTime": "2019-06-27T02:58:09Z",
"HeartbeatRate": 30,
"State": "InUse",
"DataDisks": {
"DataDisk": [
{
"Index": 1,
"Size": 20,
"Parts": {
"Part": [
{
"CanBlock": false,
"SizeBytes": 21474836480,
"Need": false,
"Device": "1_0",
"Path": "/home/data"
}
]
},
"Path": "/home/data"
}
]
},
"SystemDiskParts": {
"SystemDiskPart": [
{
"CanBlock": true,
"SizeBytes": 254803968,
"Need": true,
"Device": "0_0",
"Path": "/boot"
}
]
},
"KernelLevel": 1,
"SourceId": "s-bp1e2fsl57knvuug****",
"AgentVersion": "1.5.2.3",
"StatusInfo": "{\"error_code\": \"S1\", \"error_msg\": \"Rsync not found. Please install rsync.\"}",
"SystemDiskSize": 40,
"Description": "Server Source Imported By GotoAliyun.",
"ErrorCode": "SourceServer.Offline",
"JobId": "j-bp19vlwm0tyigbmj****",
"Platform": "OpenSUSE",
"ReplicationDriver": "SMT",
"Name": "SourceServerName",
"SystemInfo": "{\\\"agent_mode\\\":\\\"daemon\\\",\\\"agent_type\\\":\\\"aliyun\\\",\\\"client_type\\\":\\\"\\\",\\\"cores\\\":\\\"2\\\",\\\"cpu_usage\\\":\\\"0.00\\\",\\\"hostname\\\":\\\"ixxxxxxxxxx\\\",\\\"ipv4\\\":\\\"10.0.0.1\\\",\\\"memory\\\":\\\"8.00\\\",\\\"memory_usage\\\":\\\"3.61\\\"}",
"Architecture": "x86_64",
"ResourceGroupId": "rg-acfmw3ty5y7****",
"Tags": {
"Tag": [
{
"Key": "TestKey",
"Value": "TestValue"
}
]
},
"Disks": {
"System": {
"Size": 100,
"Offset": 1024,
"Parts": {
"Part": [
{
"CanBlock": false,
"SizeBytes": 21474836480,
"Path": "/home/data",
"Type": "Normal"
}
]
}
},
"Data": {
"Data": [
{
"Size": 80,
"Offset": 1024,
"Parts": {
"Part": [
{
"CanBlock": false,
"SizeBytes": 21474836480,
"Path": "/home/data",
"Type": "Normal"
}
]
}
}
]
}
},
"WorkgroupId": "w-bp1ja22kdqphehlj****"
}
]
},
"TotalCount": 1,
"PageSize": 10,
"RequestId": "410E6073-66D0-45D3-AB3E-4DC3F5E4****",
"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 request parameters of the API has changed. The response structure of the API has changed | View Change Details |
| 2024-05-30 | The Error code has changed. The request parameters of the API has changed | View Change Details |
| 2023-07-28 | The Error code has changed | View Change Details |