Queries the information about one or more migration sources.

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.

Request parameters

ParameterTypeRequiredExampleDescription
ActionStringYesDescribeSourceServers

The operation that you want to perform. Set the value to DescribeSourceServers.

JobIdStringNoj-bp19vlwm0tyigbmj****

The migration job ID.

StateStringNoAvailable

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).
NameStringNotestSourceServerName

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.

PageNumberIntegerNo1

The page number. Pages start from page 1.

Default value: 1.

PageSizeIntegerNo10

The number of entries per page. Valid values: 1 to 50.

Default value: 10.

SourceId.NStringNos-bp1e2fsl57knvuug****

The migration source ID. You can specify multiple IDs.

ResourceGroupIdStringNorg-acfmw3ty5y7****

The resource group ID.

Tag.N.KeyStringNoTestKey

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://.

Tag.N.ValueStringNoTestValue

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://.

Response parameters

ParameterTypeExampleDescription
SourceServersArray of SourceServer

The queried migration sources.

SourceServer
CreationTimeString2019-06-27T02:58:09Z

The time when the migration source was created.

HeartbeatRateInteger30

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

StateStringInUse

The state of the migration source.

DataDisksArray of DataDisk

The data disks on the migration source.

DataDisk
IndexInteger1

The index number of the data disk.

SizeInteger20

The size of the data disk. Unit: GiB.

PartsArray of Part

The data disk partitions.

Part
CanBlockBooleanfalse

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

SizeBytesLong21474836480

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

NeedBooleanfalse

Indicates whether the data disk partition must be selected.

DeviceString1_0

The device ID of the data disk partition.

PathString/home/data

The path of the data disk partition.

PathString/home/data

The path of the data disk.

SystemDiskPartsArray of SystemDiskPart

The system disk partitions.

SystemDiskPart
CanBlockBooleantrue

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

SizeBytesLong254803968

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

NeedBooleantrue

Indicates whether the system disk partition must be selected.

DeviceString0_0

The device ID of the system disk partition.

PathString/boot

The path of the system disk partition.

KernelLevelInteger1

The kernel level of the migration source.

SourceIdStrings-bp1e2fsl57knvuug****

The migration source ID.

AgentVersionString1.5.2.3

The version number of the SMC client.

StatusInfoString{"error_code": "S1", "error_msg": "Rsync not found. Please install rsync."}

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

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

DescriptionStringServer Source Imported By GotoAliyun.

The description of the migration source.

ErrorCodeStringSourceServer.Offline

The error code of the migration source.

JobIdStringj-bp19vlwm0tyigbmj****

The last migration job ID.

PlatformStringOpenSUSE

The operating system of the migration source.

ReplicationDriverStringSMT

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

NameStringSourceServerName

The name of the migration source.

SystemInfoString{\"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\"}

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 hostname. 
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. 
                                
ArchitectureStringx86_64

The system architecture of the migration source.

ResourceGroupIdStringrg-acfmw3ty5y7****

The resource group ID.

TagsArray of Tag

The tags.

Tag
KeyStringTestKey

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://.

ValueStringTestValue

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://.

TotalCountInteger1

The total number of migration sources returned.

PageSizeInteger10

The number of entries per page.

RequestIdString410E6073-66D0-45D3-AB3E-4DC3F5E4****

The request ID.

PageNumberInteger1

The page number.

Examples

Sample requests

http(s)://smc.aliyuncs.com/?Action=DescribeSourceServers
&JobId=j-bp19vlwm0tyigbmj****
&State=Available
&Name=testSourceServerName
&PageNumber=1
&PageSize=10
&SourceId=["s-bp1e2fsl57knvuug****"]
&ResourceGroupId=rg-acfmw3ty5y7****
&Tag=[{"Key":"TestKey","Value":"TestValue"}]
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeSourceServersResponse>
    <SourceServers>
        <CreationTime>2019-06-27T02:58:09Z</CreationTime>
        <HeartbeatRate>30</HeartbeatRate>
        <State>InUse</State>
        <DataDisks>
            <Index>1</Index>
            <Size>20</Size>
            <Parts>
                <CanBlock>false</CanBlock>
                <SizeBytes>21474836480</SizeBytes>
                <Need>false</Need>
                <Device>1_0</Device>
                <Path>/home/data</Path>
            </Parts>
            <Path>/home/data</Path>
        </DataDisks>
        <SystemDiskParts>
            <CanBlock>true</CanBlock>
            <SizeBytes>254803968</SizeBytes>
            <Need>true</Need>
            <Device>0_0</Device>
            <Path>/boot</Path>
        </SystemDiskParts>
        <KernelLevel>1</KernelLevel>
        <SourceId>s-bp1e2fsl57knvuug****</SourceId>
        <AgentVersion>1.5.2.3</AgentVersion>
        <StatusInfo>{"error_code": "S1", "error_msg": "Rsync not found. Please install rsync."}</StatusInfo>
        <SystemDiskSize>40</SystemDiskSize>
        <Description>Server Source Imported By GotoAliyun.</Description>
        <ErrorCode>SourceServer.Offline</ErrorCode>
        <JobId>j-bp19vlwm0tyigbmj****</JobId>
        <Platform>OpenSUSE</Platform>
        <ReplicationDriver>SMT</ReplicationDriver>
        <Name>SourceServerName</Name>
        <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\"}</SystemInfo>
        <Architecture>x86_64</Architecture>
        <ResourceGroupId>rg-acfmw3ty5y7****</ResourceGroupId>
        <Tags>
            <Key>TestKey</Key>
            <Value>TestValue</Value>
        </Tags>
    </SourceServers>
    <TotalCount>1</TotalCount>
    <PageSize>10</PageSize>
    <RequestId>410E6073-66D0-45D3-AB3E-4DC3F5E4****</RequestId>
    <PageNumber>1</PageNumber>
</DescribeSourceServersResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "SourceServers" : [ {
    "CreationTime" : "2019-06-27T02:58:09Z",
    "HeartbeatRate" : 30,
    "State" : "InUse",
    "DataDisks" : [ {
      "Index" : 1,
      "Size" : 20,
      "Parts" : [ {
        "CanBlock" : false,
        "SizeBytes" : 21474836480,
        "Need" : false,
        "Device" : "1_0",
        "Path" : "/home/data"
      } ],
      "Path" : "/home/data"
    } ],
    "SystemDiskParts" : [ {
      "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" : [ {
      "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.You do not have the permissions on the specified resource.
500InternalErrorAn error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.An internal error occurred. Try again later. If the error persists, submit a ticket.

For a list of error codes, see Service error codes.