DescribeSourceServers - Server Migration Center - Alibaba Cloud Documentation Center

Description

You can specify multiple request parameters to be queried. Specified parameters have logical AND relations. Parameters without assigned values are not used as filtering conditions.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeSourceServers	The operation that you want to perform. Set the value to DescribeSourceServers.
JobId	String	No	j-bp19vlwm0tyigbmj****	The ID of the migration task.
State	String	No	Available	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).
Name	String	No	testSourceServerName	The name of the migration source. The name must be 2 to 128 characters in length. The name must start with a letter but cannot start with http:// or https://. The name can contain digits, colons (:), underscores (_), and hyphens (-). Default value: null.
PageNumber	Integer	No	1	The number of the page to return. Pages start from page 1. Default value: 1.
PageSize	Integer	No	10	The number of entries to return on each page. The value cannot exceed 50. Default value: 10.
SourceId.N	String	No	s-bp1e2fsl57knvuug****	The ID of the migration source. You can specify multiple IDs.
ResourceGroupId	String	No	rg-acfmw3ty5y7****	The ID of the resource group.

Response parameters


Parameter	Type	Example	Description
SourceServers	Array of SourceServer		The information about the migration sources returned.
SourceServer
CreationTime	String	2019-06-27T02:58:09Z	The time when the migration source was created.
HeartbeatRate	Integer	30	The interval at which heartbeats are sent from the SMC client. Unit: seconds.
State	String	InUse	The state of the migration source.
DataDisks	Array of DataDisk		The data disks on the migration source.
DataDisk
Index	Integer	1	The index number of the data disk.
Size	Integer	20	The size of the data disk. Unit: GiB.
Parts	Array of Part		The information about data disk partitions.
Part
CanBlock	Boolean	false	Indicates whether block replication is enabled for the data disk partition.
SizeBytes	Long	21474836480	The size of the data disk partition. Unit: bytes.
Need	Boolean	false	Indicates whether the data disk partition must be selected.
Device	String	1_0	The device ID of the data disk partition.
Path	String	/home/data	The path of the data disk partition.
Path	String	/home/data	The path of the data disk.
SystemDiskParts	Array of SystemDiskPart		The information about system disk partitions.
SystemDiskPart
CanBlock	Boolean	true	Indicates whether block replication is enabled for the system disk partition.
SizeBytes	Long	254803968	The size of the system disk partition. Unit: bytes.
Need	Boolean	true	Indicates whether the system disk partition must be selected.
Device	String	0_0	The device ID of the system disk partition.
Path	String	/boot	The path of the system disk partition.
KernelLevel	Integer	1	The kernel level of the migration source.
SourceId	String	s-bp1e2fsl57knvuug****	The ID of the migration source.
AgentVersion	String	1.5.2.3	The version number of the SMC client.
StatusInfo	String	{"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`
SystemDiskSize	Integer	40	The system disk size of the migration source. Unit: GiB.
Description	String	Server Source Imported By GotoAliyun.	The description of the migration source.
ErrorCode	String	SourceServer.Offline	The error code of the migration source.
JobId	String	j-bp19vlwm0tyigbmj****	The ID of the last migration task.
Platform	String	OpenSUSE	The operating system of the migration source.
ReplicationDriver	String	SMT	The replication driver used for migration. Default value: SMT.
Name	String	SourceServerName	The name of the migration source.
SystemInfo	String	{\"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.`
Architecture	String	x86_64	The system architecture of the migration source.
ResourceGroupId	String	rg-acfmw3ty5y7****	The ID of the resource group.
TotalCount	Integer	1	The total number of migration sources returned.
PageSize	Integer	10	The number of entries returned per page.
RequestId	String	410E6073-66D0-45D3-AB3E-4DC3F5E4****	The ID of the request.
PageNumber	Integer	1	The page number of the returned page.

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****
&<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>
    </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****"
  } ],
  "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.	The error message returned because you do not have the permissions on the specified resource.
500	InternalError	An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.	The error message returned because an internal error has occurred. Try again later. If the error persists, submit a ticket.

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