All Products
Search
Document Center

Server Migration Center:DescribeSourceServers

Last Updated:Mar 03, 2024

Queries the information about migration sources.

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.

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
JobIdstringNo

The migration job ID.

j-bp19vlwm0tyigbmj****
StatestringNo

The state of the migration source. Valid Values:

  • Unavailable: The migration source is inactive, or an error occurs in the migration source.
  • Available: The migration source is active.
  • InUse: The migration source is being migrated.
  • Deleting: The migration source is being deleted from Server Migration Center (SMC).
Available
NamestringNo

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
PageNumberintegerNo

The page number. 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 migration source IDs. You can specify multiple IDs.

stringNo

The migration source ID. You can specify multiple IDs.

s-bp1e2fsl57knvuug****
ResourceGroupIdstringNo

The ID of the resource group.

rg-acfmw3ty5y7****
Tagobject []No

The tag.

KeystringNo

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
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

The response parameters.

SourceServersobject []

The information about the migration source.

CreationTimestring

The time when the migration source was created.

2019-06-27T02:58:09Z
HeartbeatRateinteger

The interval at which heartbeats are sent from the SMC client. Unit: seconds.

30
Statestring

The state of the migration source.

InUse
DataDisksobject []

The data disk on the migration source.

Indexinteger

The index number of the data disk.

1
Sizeinteger

The size of the data disk. Unit: GiB.

20
Partsobject []

The information about the data disk partition.

CanBlockboolean

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

false
SizeByteslong

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

21474836480
Needboolean

Indicates whether the data disk partition must be selected.

false
Devicestring

The device ID of the data disk partition.

1_0
Pathstring

The path of the data disk partition.

/home/data
Pathstring

The path of the data disk.

/home/data
SystemDiskPartsobject []

The information about the system disk partition.

CanBlockboolean

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

true
SizeByteslong

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

254803968
Needboolean

Indicates whether the system disk partition must be selected.

true
Devicestring

The device ID of the system disk partition.

0_0
Pathstring

The path of the system disk partition.

/boot
KernelLevelinteger

The kernel level of the migration source.

1
SourceIdstring

The ID of the migration source.

s-bp1e2fsl57knvuug****
AgentVersionstring

The version number of the SMC client.

1.5.2.3
StatusInfostring

The status information of the migration source. This parameter is returned if the migration source is in the Unavailable state. The value of this parameter consists of key-value pairs in the JSON format. Sample keys:

error_code: The error code.
error_msg: The error message.
{"error_code": "S1", "error_msg": "Rsync not found. Please install rsync."}
SystemDiskSizeinteger

The system disk size of the migration source. Unit: GiB.

40
Descriptionstring

The description of the migration source.

Server Source Imported By GotoAliyun.
ErrorCodestring

The error code of the migration source.

SourceServer.Offline
JobIdstring

The ID of the last migration job.

j-bp19vlwm0tyigbmj****
Platformstring

The operating system of the migration source.

OpenSUSE
ReplicationDriverstring

The replication driver used for migration. Default value: SMT.

SMT
Namestring

The name of the migration source.

SourceServerName
SystemInfostring

The system information of the migration source. The value of this parameter consists of key-value pairs in the JSON format. The key-value pairs are extensible and have fixed keys. The JSON string does not exceed 1 KB in size. Sample keys:

agent_mode: The migration mode.
agent_type: The migration type.
client_type: The client type.
hostname: The host name.
ipv4: The IPv4 address.
ipv6: The IPv6 address.
.cores: The number of CPU cores.
cpu_usage: The CPU utilization.
memory: The memory size.
memory_usage: The memory usage.
{\"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\"}
Architecturestring

The system architecture of the migration source.

x86_64
ResourceGroupIdstring

The resource group ID.

rg-acfmw3ty5y7****
Tagsobject []

The information about the tags.

Keystring

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

You cannot specify empty strings as tag keys. It can be up to 64 characters in length and cannot start with acs: or aliyun. It 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 key can be an empty string. It can be up to 64 characters in length and cannot contain http:// or https://.

TestValue
TotalCountinteger

The total number of migration sources returned.

1
PageSizeinteger

The number of entries returned per page.

10
RequestIdstring

The request ID.

410E6073-66D0-45D3-AB3E-4DC3F5E4****
PageNumberinteger

The page number.

1

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"
            }
          ]
        }
      }
    ]
  },
  "TotalCount": 1,
  "PageSize": 10,
  "RequestId": "410E6073-66D0-45D3-AB3E-4DC3F5E4****",
  "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