DescribeSourceServers - Server Migration Center - Alibaba Cloud Documentation Center

Call the DescribeSourceServers operation to query information about one or more migration sources.

Operation description

Description

The request parameters are used as filters and are combined with a logical AND. If a parameter is empty, the corresponding filter is ignored.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

smc:DescribeSourceServers

get

*SourceServer

acs:smc:{#regionId}:{#accountId}:sourceserver/{#SourceServerId}

None

Request parameters

Parameter	Type	Required	Description	Example
JobId	string	No	The ID of the migration task.	j-bp19vlwm0tyigbmj****
State	string	No	The state of the source server. Valid values: Unavailable: The source server is unavailable. This includes offline and error states. Available: The source server is online. InUse: The source server is being migrated. Deleting: The source server is being deleted.	Available
Name	string	No	The name of the source server. The name must be 2 to 128 characters in length. It must start with a letter and cannot start with `http://` or `https://`. The name can contain digits, colons (:), underscores (_), and hyphens (-). Default value: empty.	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. Maximum value: 50. Default value: 10.	10
SourceId	array	No	The ID of the source server. You can specify multiple IDs.	s-bp1e2fsl57knvuug****
	string	No	The ID of the source server. You can specify multiple IDs.	s-bp1e2fsl57knvuug****
ResourceGroupId	string	No	The ID of the resource group.	rg-acfmw3ty5y7****
Tag	array<object>	No	The tags.
	object	No	The tag.
Key	string	No	The key of tag N. N can be an integer from 1 to 20. The tag key cannot be an empty string. The tag key can be up to 64 characters in length. It cannot start with `aliyun` or `acs:` and cannot contain `http://` or `https://`.	TestKey
Value	string	No	The value of tag N. N can be an integer from 1 to 20. The tag value can be an empty string. The tag value can be up to 64 characters in length. It cannot contain `http://` or `https://`.	TestValue
RelatedJobType	array	No	The type of the associated task.
	string	No	The type of the associated task. Valid values: Not_Related: No task is associated. Server: A server migration task. Os: An operating system migration task. Cross_Zone: A cross-zone migration task. VMWare: A VMware migration task. Desktop: A desktop task.	Server
WorkgroupId	string	No	The ID of the workgroup.	w-bp1ja22kdqphehlj****

Response elements

Element	Type	Description	Example
	object	The response parameters.
SourceServers	object
SourceServer	array<object>	The information about the source servers.
	object	The information about the source servers.
CreationTime	string	The time when the source server was created.	2019-06-27T02:58:09Z
HeartbeatRate	integer	The heartbeat interval of the Server Migration Center (SMC) client. Unit: seconds.	30
State	string	The state of the source server.	InUse
DataDisks	object
DataDisk	array<object>	The data disks of the source server.
	object	The data disks of the source server.
Index	integer	The index number of the data disk.	1
Size	integer	The size of the data disk. Unit: GiB.	20
Parts	object
Part	array<object>	The partitions of the data disk.
	object	The partitions of the data disk.
CanBlock	boolean	Indicates whether block replication is supported for the data disk partition.	false
SizeBytes	integer	The size of the data disk partition. Unit: bytes.	21474836480
Need	boolean	Indicates whether the data disk partition must be selected.	false
Device	string	The device ID of the data disk partition.	1_0
Path	string	The mount point of the data disk partition.	/home/data
Path	string	The mount point of the data disk.	/home/data
SystemDiskParts	object
SystemDiskPart	array<object>	The partitions of the system disk.
	object	The partitions of the system disk.
CanBlock	boolean	Indicates whether block replication is supported for the system disk partition.	true
SizeBytes	integer	The size of the system disk partition. Unit: bytes.	254803968
Need	boolean	Indicates whether the system disk partition must be selected.	true
Device	string	The device ID of the system disk partition.	0_0
Path	string	The mount point of the system disk partition.	/boot
KernelLevel	integer	The kernel level.	1
SourceId	string	The ID of the source server.	s-bp1e2fsl57knvuug****
AgentVersion	string	The version of the SMC client.	1.5.2.3
StatusInfo	string	The information about the state of the source server. This parameter is returned when the source server is in an abnormal state. The value is a JSON-formatted key-value pair. Example: `- error_code: The error code. - error_msg: The error message.`	{"error_code": "S1", "error_msg": "Rsync not found. Please install rsync."}
SystemDiskSize	integer	The size of the system disk of the source server. Unit: GiB.	40
Description	string	The description of the source server.	Server Source Imported By GotoAliyun.
ErrorCode	string	The error code returned if the source server is in an abnormal state.	SourceServer.Offline
JobId	string	The ID of the last migration task.	j-bp19vlwm0tyigbmj****
Platform	string	The operating system of the source server.	OpenSUSE
ReplicationDriver	string	The replication driver. Default value: SMT.	SMT
Name	string	The name of the source server.	SourceServerName
SystemInfo	string	The system information of the source server. The value is a JSON-formatted key-value pair that cannot exceed 1 KB in size. Example: `agent_mode: The running mode. agent_type: The running 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 usage. 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\"}
Architecture	string	The architecture of the source server.	x86_64
ResourceGroupId	string	The ID of the resource group.	rg-acfmw3ty5y7****
Tags	object
Tag	array<object>	The tags.
	object	The tag.
Key	string	The key of tag N. N can be an integer from 1 to 20. The tag key cannot be an empty string. The tag key can be up to 64 characters in length. It cannot start with `aliyun` or `acs:` and cannot contain `http://` or `https://`.	TestKey
Value	string	The value of tag N. N can be an integer from 1 to 20. The tag value can be an empty string. The tag value can be up to 64 characters in length. It cannot contain `http://` or `https://`.	TestValue
Disks	object	The information about the disks.
System	object	The information about the system disk.
Size	integer	The size of the system disk of the source server. Unit: GiB. The value must be in the range of 20 to 32,768. Note The value of this parameter must be greater than the used space of the data disk on the source server. For example, if the data disk is 500 GiB in size and 100 GiB of the space is used, the value of this parameter must be greater than 100.	100
Offset	integer	The start offset of the first partition on the system disk. Unit: bytes.	1024
Parts	object
Part	array<object>	The partitions of the system disk.
	object	The information about the partition.
CanBlock	boolean	Indicates whether block replication is supported for the system disk partition. Valid values: true: Block replication is supported for the system disk partition. false: Block replication is not supported for the system disk partition.	false
SizeBytes	integer	The size of the system disk partition. Unit: bytes.	21474836480
Path	string	The mount point of the system disk partition.	/home/data
Type	string	The type of the system disk partition. Valid values: Normal: A normal partition. System: A system partition. Boot: A boot partition.	Normal
Data	object
Data	array<object>	The information about the data disks.
	object	The information about the data disk.
Size	integer	The size of the data disk of the source server. Unit: GiB.	80
Offset	integer	The start offset of the first partition on the data disk. Unit: bytes.	1024
Parts	object
Part	array<object>	The partitions of the data disk.
	object	The information about the data disk partitions.
CanBlock	boolean	Indicates whether block replication is enabled for the data disk partition. Valid values: true: Block replication is enabled for the data disk partition. false: Block replication is not enabled for the data disk partition.	false
SizeBytes	integer	The size of the data disk partition. Unit: bytes.	21474836480
Path	string	The mount point of the data disk partition.	/home/data
Type	string	The type of the data disk partition. Valid values: Normal: A normal partition. System: A system partition. Boot: A boot partition.	Normal
WorkgroupId	string	The ID of the workgroup.	w-bp1ja22kdqphehlj****
TotalCount	integer	The total number of source servers.	1
PageSize	integer	The number of entries per page.	10
RequestId	string	The ID of the request.	410E6073-66D0-45D3-AB3E-4DC3F5E4****
PageNumber	integer	The page number.	1

Examples

Success response

JSON format

{
  "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
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.
403	Forbidden.Unauthorized	A required authorization for the specified action is not supplied.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.