使用DescribeSourceServers查詢遷移源資訊-Server Migration Center-阿里雲

調用DescribeSourceServers查詢一個或多個遷移源資訊。

介面說明

請求參數的作用類似於一個過濾器，過濾器為邏輯與（AND）關係。如果某一參數為空白，則過濾器不起作用。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

smc:DescribeSourceServers

get

*SourceServer

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

無

請求參數

名稱	類型	必填	描述	樣本值
JobId	string	否	遷移任務 ID。	j-bp19vlwm0tyigbmj****
State	string	否	遷移源狀態。取值範圍： Unavailable：不可用，包括離線和出錯。 Available：線上。 InUse：遷移中。 Deleting：刪除中。	Available
Name	string	否	遷移源名稱。長度為 2~128 個英文或中文字元。必須以大小寫字母或中文開頭，不能以 http://和 https://開頭。可以包含數字、半形冒號（:）、底線（_）或者連字號（-）。預設值：空	testSourceServerName
PageNumber	integer	否	返回的遷移源列表的頁碼。起始值：1。預設值：1。	1
PageSize	integer	否	分頁查詢時設定的每頁行數。最大值：50。預設值：10。	10
SourceId	array	否	遷移源 ID，可以輸入多個。	s-bp1e2fsl57knvuug****
	string	否	遷移源 ID，可以輸入多個。	s-bp1e2fsl57knvuug****
ResourceGroupId	string	否	資源群組 ID。	rg-acfmw3ty5y7****
Tag	array<object>	否	標籤。
	object	否	標籤對象。
Key	string	否	為 SMC 資源指定的標籤鍵。N 的取值範圍：1~20 一旦傳入該值，則不允許為空白字串。最多支援 64 個字元，不能以 aliyun 和 acs:開頭，不能包含 http://或者 https://。	TestKey
Value	string	否	為 SMC 資源指定的標籤值。N 的取值範圍：1~20。一旦傳入該值，可以為空白字串。最多支援 64 個字元，不能包含 http://或者 https://。	TestValue
RelatedJobType	array	否	關聯任務類型。
	string	否	關聯任務類型。取值如下： Not_Related：未關聯任務。 Server：伺服器遷移任務。 Os：作業系統遷移任務。 Cross_Zone：跨可用性區域遷移任務。 VMWare：VMWare 遷移任務。 Desktop：案頭任務。	Server
WorkgroupId	string	否	工作群組識別碼。	w-bp1ja22kdqphehlj****

返回參數

名稱	類型	描述	樣本值
	object	資訊集合。
SourceServers	object
SourceServer	array<object>	遷移源數組。
	object	遷移源數組。
CreationTime	string	遷移源的註冊時間。	2019-06-27T02:58:09Z
HeartbeatRate	integer	SMC 用戶端（SMC Agent）心跳頻率。單位：秒。	30
State	string	遷移源狀態。	InUse
DataDisks	object
DataDisk	array<object>	遷移源的資料盤數組。
	object	遷移源的資料盤數組。
Index	integer	資料盤順序。	1
Size	integer	資料盤 N 大小。單位：GiB。	20
Parts	object
Part	array<object>	資料盤分區資訊。
	object	資料盤分區資訊。
CanBlock	boolean	資料盤分區是否支援塊複製。	false
SizeBytes	integer	資料盤分區大小。單位：Byte。	21474836480
Need	boolean	資料盤分區是否必須選擇。	false
Device	string	資料盤分區裝置標識。	1_0
Path	string	資料盤分區路徑。	/home/data
Path	string	資料盤 N 路徑。	/home/data
SystemDiskParts	object
SystemDiskPart	array<object>	系統硬碟分區資訊。
	object	系統硬碟分區資訊。
CanBlock	boolean	系統硬碟分區是否支援塊複製。	true
SizeBytes	integer	系統硬碟分區大小。單位：Byte。	254803968
Need	boolean	系統硬碟分區是否必須選擇。	true
Device	string	系統硬碟分區裝置標識符。	0_0
Path	string	系統硬碟分區路徑。	/boot
KernelLevel	integer	核心版本層級。	1
SourceId	string	遷移源 ID。	s-bp1e2fsl57knvuug****
AgentVersion	string	SMC 用戶端版本號碼。	1.5.2.3
StatusInfo	string	遷移源狀態詳細資料。該參數在遷移源狀態為異常時返回。JSON 格式索引值對，如： `- error_code：錯誤碼。 - error_msg：錯誤資訊。`	{"error_code": "S1", "error_msg": "Rsync not found. Please install rsync."}
SystemDiskSize	integer	遷移源的系統硬碟大小。單位：GiB	40
Description	string	遷移源描述。	Server Source Imported By GotoAliyun.
ErrorCode	string	遷移源狀態錯誤碼。	SourceServer.Offline
JobId	string	最近一次的遷移任務 ID。	j-bp19vlwm0tyigbmj****
Platform	string	遷移源的系統平台。	OpenSUSE
ReplicationDriver	string	複製磁碟機。預設值：SMT（遷雲工具）	SMT
Name	string	遷移源的名稱。	SourceServerName
SystemInfo	string	遷移源系統資訊。JSON 格式索引值對，可擴充，索引值固定。大小不超過 1 KB。如： `agent_mode：運行模式。 agent_type：運行類型。 client_type：用戶端類型。 hostname ：主機名稱。 ipv4：IPv4 地址。 ipv6： IPv6 地址。 cores：CPU 核心數。 cpu_usage： CPU 使用率。 memory：記憶體。 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	遷移源的系統架構。	x86_64
ResourceGroupId	string	資源群組 ID。	rg-acfmw3ty5y7****
Tags	object
Tag	array<object>	標籤資訊。
	object	標籤對象。
Key	string	為 SMC 資源指定的標籤鍵。N 的取值範圍：1~20。一旦傳入該值，則不允許為空白字串。最多支援 64 個字元，不能以 aliyun 和 acs:開頭，不能包含 http://或者 https://。	TestKey
Value	string	為 SMC 資源指定的標籤值。N 的取值範圍：1~20。一旦傳入該值，可以為空白字串。最多支援 64 個字元，不能包含 http://或者 https://。	TestValue
Disks	object	磁碟資訊。
System	object	系統硬碟資訊。
Size	integer	遷移源系統硬碟的大小，單位：GiB。取值範圍為 20~32768。說明參數取值需要大於原始伺服器資料盤實際佔用大小。例如，來源資料盤大小為 500 GiB，實際佔用 100 GiB，則該參數取值需大於 100 GiB。	100
Offset	integer	系統硬碟首個分區的起始位移。單位：Byte。	1024
Parts	object
Part	array<object>	系統硬碟分區資訊。
	object	分區資訊。
CanBlock	boolean	系統硬碟分區是否支援塊複製。可能值： true：系統硬碟分區支援塊複製。 false：系統硬碟分區不支援塊複製。	false
SizeBytes	integer	系統硬碟分區大小。單位：Byte。	21474836480
Path	string	系統硬碟分區路徑。	/home/data
Type	string	系統硬碟分區類型。可能值： Normal：普通分區。 System：系統磁碟分割。 Boot：開機磁碟分割。	Normal
Data	object
Data	array<object>	資料盤資訊列表。
	object	資料盤資訊。
Size	integer	遷移源的資料磁碟大小。單位：GiB。	80
Offset	integer	資料盤首個分區的起始位移。單位：Byte。	1024
Parts	object
Part	array<object>	資料盤分區資訊。
	object	資料盤分區資訊。
CanBlock	boolean	資料盤分區是否開啟塊複製。可能值： true：資料盤分區開啟塊複製。 false：資料盤分區不開啟塊複製。	false
SizeBytes	integer	資料盤分區大小。單位：Byte。	21474836480
Path	string	資料盤分區路徑。	/home/data
Type	string	資料盤分區類型。可能值： Normal：普通分區。 System：系統磁碟分割。 Boot：開機磁碟分割。	Normal
WorkgroupId	string	工作群組識別碼。	w-bp1ja22kdqphehlj****
TotalCount	integer	遷移源總數。	1
PageSize	integer	每頁行數。	10
RequestId	string	請求 ID。	410E6073-66D0-45D3-AB3E-4DC3F5E4****
PageNumber	integer	遷移源列表的頁碼。	1

樣本

正常返回樣本

JSON格式

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

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
500	InternalError	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.	使用者未授權操作指定的資源。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。