DescribeReplicationJobs查詢遷移任務-Server Migration Center-阿里雲

調用DescribeReplicationJobs查詢一個或多個遷移任務的詳細資料。

介面說明

請求參數的作用類似於一個過濾器，過濾器為邏輯與（AND）關係。如果某一參數為空白，則過濾器不起作用。
支援遷移源的遷移目標為 Docker 容器鏡像，實現低成本容器化應用遷移。關於 Docker 容器鏡像詳情請參見Container Registry。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

smc:DescribeReplicationJobs

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
Name	string	否	遷移任務的名稱。	testMigrationTaskName
RegionId	string	否	遷移源需遷入的目標阿里雲地區 ID。例如，您需要遷移原始伺服器至杭州，則 RegionId 為`cn-hangzhou`。您可以調用 DescribeRegions 查看最新的阿里雲地區列表。	cn-hangzhou
Status	string	否	遷移任務的主狀態。取值範圍： Ready：未開始。 Running：運行中。 Stopped：已暫停。 InError：出錯。 Finished：已完成。 Waiting：等待中。 Expired：已到期。 Deleting：刪除中。	Ready
BusinessStatus	string	否	遷移任務的業務狀態。取值範圍： Preparing：準備中。 Syncing：同步中。 Processing：處理中。 Cleaning：清理中。	Preparing
PageNumber	integer	否	返回結果中，遷移工作清單的頁碼。起始值：1。預設值：1。	1
PageSize	integer	否	分頁查詢時設定的每頁行數。最大值：50。預設值：10。	10
SourceId	array	否	遷移源 ID 列表。N 的最大值為 50。	s-bp1e2fsl57knvuug****
	string	否	遷移源 ID 列表。N 的最大值為 50。	s-bp1bjhkwk2j5hlbn****
JobId	array	否	遷移任務 ID 列表。N 的最大值：50。	j-bp19vlwm0tyigbmj****
	string	否	遷移任務 ID 列表。N 的最大值：50。	j-bp1h3d33mekxwu0n****
JobType	integer	否	遷移任務的類型。取值範圍： 0：伺服器遷移。 1：作業系統遷移。 2：跨可用性區域遷移。 3：VMware 無代理遷移。	0
InstanceId	array	否	執行個體 ID。
	string	否	目標執行個體 ID。	i-bp1f1dvfto1sigz5****
ResourceGroupId	string	否	資源群組 ID。	rg-acfmw3ty5y7****
Tag	array<object>	否	為 SMC 資源指定的標籤。
	object	否	為 SMC 資源指定的標籤。
Key	string	否	為 SMC 資源指定的標籤鍵。N 的取值範圍：1~20。一旦傳入該值，可以為空白字串。最多支援 64 個字元，不能包含 http://或者 https://。	TestKey
Value	string	否	為 SMC 資源指定的標籤值。N 的取值範圍：1~20。一旦傳入該值，可以為空白字串。最多支援 64 個字元，不能包含 http://或者 https://。	TestValue

返回參數

名稱	類型	描述	樣本值
	object
TotalCount	integer	遷移任務總個數。	5
ReplicationJobs	object
ReplicationJob	array<object>	遷移任務詳情的集合。
	object	遷移任務詳情的集合。
Frequency	integer	增量遷移任務自動執行的時間間隔，單位：小時。取值範圍：1~168。	15
VpcId	string	已配置Express Connect服務或者 VPN 閘道的 VPC ID。	vpc-bp1vwnn14rqpyiczj****
CreationTime	string	遷移任務的建立時間。	2014-07-24T13:00:52Z
Status	string	遷移任務的主狀態。可能值： Ready：未開始。 Running：運行中。 Stopped：已暫停。 InError：出錯。 Finished：已完成。 Waiting：等待中。 Expired：已到期。 Deleting：刪除中。	Running
ScheduledStartTime	string	遷移任務的執行時間。按照ISO 8601標準表示，並使用 UTC+0 時間，格式為 yyyy-MM-ddTHH:mm:ssZ。該參數值的設定需滿足以下要求：該參數值必須晚於目前時間，並且需要設定在 30 天以內。如果該參數值為空白，則 SMC 不會啟動遷移任務，需要您調用 StartReplicationJob 啟動任務。	2019-06-04T13:35:00Z
MaxNumberOfImageToKeep	integer	增量遷移任務預設保留的最大鏡像數。取值範圍：1~10。	8
ContainerNamespace	string	Docker 的命名空間。	testNamespace
DataDisks	object
DataDisk	array<object>	目標阿里雲伺服器 ECS 的資料盤。
	object	目標阿里雲伺服器 ECS 的資料盤。
Index	integer	資料盤順序。	1
Size	integer	資料盤大小。單位：GiB。	40
Parts	object
Part	array<object>	資料盤分區資訊。
	object	資料盤分區資訊。
SizeBytes	integer	資料盤分區大小。單位：Byte。	21474836480
Block	boolean	分區是否開啟塊複製。	true
Device	string	資料盤分區裝置標識。	0_1
StatusInfo	string	遷移狀態的詳細資料。	statusinfo
InstanceRamRole	string	執行個體 RAM 角色名稱。	SMCAdmin
SystemDiskSize	integer	目標阿里雲伺服器 ECS 的系統硬碟大小。	40
Description	string	遷移任務的描述。	This is my migration task.
ReplicationParameters	string	複製磁碟機參數資訊。	BandWidthLimit:0
ErrorCode	string	遷移任務的錯誤碼。	InternalError
ValidTime	string	遷移任務的到期時間。按照ISO 8601標準表示，並使用 UTC+0 時間，格式為 yyyy-MM-ddTHH:mm:ssZ。說明 +8 小時後是控制台上顯示的時間。	2019-06-08T14:40:52Z
NetMode	integer	遷移時使用的網路類型。	0
ContainerTag	string	Docker 的鏡像標籤。	CentOS:v1
LicenseType	string	遷移任務的許可證類型。可能值：空值：無許可證。 BYOL：自備授權。	BYOL
Name	string	遷移任務名稱。	testMigrationTaskName
ImageId	string	遷移任務交付的目標鏡像 ID。	m-o6w3gy99qf89rkga****
Progress	number	遷移任務總進度。	100
RunOnce	boolean	區分一次性遷移任務和增量遷移任務。可能值： true：一次性遷移任務。任務建立後僅執行一次。 false：增量遷移任務。任務建立後，按照`Frequency`設定的時間間隔，周期性自動執行。	true
LaunchTemplateId	string	執行個體啟動模板 ID。	lt-launchtemplateid
ContainerRepository	string	Docker 的鏡像倉庫。	testRepository
InstanceId	string	目標執行個體 ID。	i-bp1ff25rzvnul6kr****
SystemDiskParts	object
SystemDiskPart	array<object>	系統硬碟分區資訊。
	object	系統硬碟分區資訊。
SizeBytes	integer	系統硬碟分區大小。單位：Byte。	254803968
Block	boolean	系統硬碟分區是否開啟塊複製。	true
Device	string	系統硬碟分區裝置標識符。	0_1
InstanceType	string	中轉執行個體的執行個體規格。	ecs.sn1ne.large
SourceId	string	遷移源 ID。	s-bp1e2fsl57knvuug****
LaunchTemplateVersion	string	一個或多個執行個體啟動模板版本。	1
RegionId	string	遷移源需遷入的目標阿里雲地區 ID。	cn-hangzhou
TransitionInstanceId	string	遷移中轉執行個體 ID。	i-bp1ff25rzvnul6kr****
EndTime	string	遷移任務的完成時間。按照ISO 8601標準表示，並使用 UTC+0 時間，格式為 yyyy-MM-ddTHH:mm:ssZ。說明 +8 小時後是控制台上顯示的時間。	2019-06-04T16:00:52Z
StartTime	string	遷移任務的開始時間。按照ISO 8601標準表示，並使用 UTC+0 時間，格式為 yyyy-MM-ddTHH:mm:ssZ。說明 +8 小時後是控制台上顯示的時間。	2019-06-04T14:40:52Z
VSwitchId	string	指定 VPC 下的虛擬交換器 ID。	vsw-bp1ddbrxdlrcbim46****
JobId	string	遷移任務 ID。	j-bp19vlwm0tyigbmj****
ImageName	string	遷移任務交付的目標鏡像名稱。	testAliCloudImageName
BusinessStatus	string	遷移任務的業務狀態。可能值： Preparing：準備中。 Syncing：同步中。 Processing：處理中。 Cleaning：清理中。	Preparing
ReplicationJobRuns	object
ReplicationJobRun	array<object>	遷移任務運行記錄。
	object	遷移任務運行記錄。
EndTime	string	遷移任務啟動並執行結束時間。按照ISO 8601標準表示，並使用 UTC+0 時間，格式為 yyyy-MM-ddTHH:mm:ssZ。說明 +8 小時後是控制台上顯示的時間。	2019-10-04T13:35:00Z
Type	string	遷移任務的執行方式。可能值： Manual：手動執行。 Schedule：定時執行或周期執行。	Schedule
StartTime	string	遷移任務啟動並執行開始時間。按照ISO 8601標準表示，並使用 UTC+0 時間，格式為 yyyy-MM-ddTHH:mm:ssZ。說明 +8 小時後是控制台上顯示的時間。	2019-10-01T13:35:00Z
ImageId	string	遷移任務產生的鏡像 ID。	m-o6w3gy99qf89rkga****
TargetType	string	遷移交付的目標類型。可能值： Image：遷移成功後，SMC 為您的遷移源產生阿里雲鏡像。 ContainerImage：遷移成功後，SMC 為您的遷移源產生 Docker 容器鏡像。 TargetInstance：遷移成功後，SMC 將您的遷移源隨即轉移至目標執行個體。當您設定該參數值時，您需要同時指定 InstanceId 參數。	Image
JobType	integer	遷移任務的類型。可能值： 0：伺服器遷移。 1：作業系統遷移。 2：跨可用性區域遷移。 3：VMware 無代理遷移。	0
ResourceGroupId	string	資源群組 ID。	rg-acfmw3ty5y7****
Tags	object
Tag	array<object>	為 SMC 資源指定的標籤。
	object	為 SMC 資源指定的標籤。
Key	string	為 SMC 資源指定的標籤鍵。N 的取值範圍：1~20。一旦傳入該值，可以為空白字串。最多支援 64 個字元，不能包含 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
LVM	boolean	是否使用 LVM。可能值： true：使用 LVM。 false：不使用 LVM。	false
DiskId	string	系統硬碟 ID。	d-2zeh4twm100qskw7z41z
Parts	object
Part	array<object>	系統硬碟分區資訊。
	object	系統硬碟分區資訊。
SizeBytes	integer	系統硬碟分區大小。單位：Byte。	21474836480
Block	boolean	系統硬碟分區是否開啟塊複製。取值： true：系統硬碟分區開啟塊複製。 false：系統硬碟分區不開啟塊複製。	true
Path	string	系統硬碟分區路徑。	/boot
Data	object
Data	array<object>	資料盤資訊。
	object	資料盤資訊。
Size	integer	目標阿里雲伺服器 ECS 的資料盤大小，單位為 GiB。取值範圍：20~32768。說明該參數取值需要大於遷移來源資料盤實際佔用大小。例如，來源資料盤大小為 500 GiB，實際佔用 100 GiB，則該參數取值需大於 100 GiB。	22548578304
LVM	boolean	是否使用 LVM。取值： true：使用 LVM。 false：不使用 LVM。	false
DiskId	string	資料盤 ID。	d-2zeh4twm100qskw7z41z
Parts	object
Part	array<object>	資料盤分區資訊。
	object	資料盤分區資訊。
SizeBytes	integer	資料盤分區大小。單位：Byte。	21474836480
Block	boolean	資料盤分區是否開啟塊複製。取值： true：資料盤分區開啟塊複製。 false：資料盤分區不開啟塊複製。	false
Path	string	資料盤分區路徑。	/home/data
WorkgroupId	string	工作群組識別碼。	w-bp1ja22kdqphehlj****
PageSize	integer	每頁行數。	10
RequestId	string	請求 ID。	6E1187E8-843A-4850-B97E-2F17F00D48F7
PageNumber	integer	遷移工作清單的頁碼。	1

樣本

正常返回樣本

JSON格式

{
  "TotalCount": 5,
  "ReplicationJobs": {
    "ReplicationJob": [
      {
        "Frequency": 15,
        "VpcId": "vpc-bp1vwnn14rqpyiczj****",
        "CreationTime": "2014-07-24T13:00:52Z",
        "Status": "Running",
        "ScheduledStartTime": "2019-06-04T13:35:00Z",
        "MaxNumberOfImageToKeep": 8,
        "ContainerNamespace": "testNamespace",
        "DataDisks": {
          "DataDisk": [
            {
              "Index": 1,
              "Size": 40,
              "Parts": {
                "Part": [
                  {
                    "SizeBytes": 21474836480,
                    "Block": true,
                    "Device": "0_1"
                  }
                ]
              }
            }
          ]
        },
        "StatusInfo": "statusinfo",
        "InstanceRamRole": "SMCAdmin",
        "SystemDiskSize": 40,
        "Description": "This is my migration task.",
        "ReplicationParameters": "BandWidthLimit:0",
        "ErrorCode": "InternalError",
        "ValidTime": "2019-06-08T14:40:52Z",
        "NetMode": 0,
        "ContainerTag": "CentOS:v1",
        "LicenseType": "BYOL",
        "Name": "testMigrationTaskName",
        "ImageId": "m-o6w3gy99qf89rkga****",
        "Progress": 100,
        "RunOnce": true,
        "LaunchTemplateId": "lt-launchtemplateid",
        "ContainerRepository": "testRepository",
        "InstanceId": "i-bp1ff25rzvnul6kr****",
        "SystemDiskParts": {
          "SystemDiskPart": [
            {
              "SizeBytes": 254803968,
              "Block": true,
              "Device": "0_1"
            }
          ]
        },
        "InstanceType": "ecs.sn1ne.large",
        "SourceId": "s-bp1e2fsl57knvuug****",
        "LaunchTemplateVersion": "1",
        "RegionId": "cn-hangzhou",
        "TransitionInstanceId": "i-bp1ff25rzvnul6kr****",
        "EndTime": "2019-06-04T16:00:52Z",
        "StartTime": "2019-06-04T14:40:52Z",
        "VSwitchId": "vsw-bp1ddbrxdlrcbim46****",
        "JobId": "j-bp19vlwm0tyigbmj****",
        "ImageName": "testAliCloudImageName",
        "BusinessStatus": "Preparing",
        "ReplicationJobRuns": {
          "ReplicationJobRun": [
            {
              "EndTime": "2019-10-04T13:35:00Z",
              "Type": "Schedule",
              "StartTime": "2019-10-01T13:35:00Z",
              "ImageId": "m-o6w3gy99qf89rkga****"
            }
          ]
        },
        "TargetType": "Image",
        "JobType": 0,
        "ResourceGroupId": "rg-acfmw3ty5y7****",
        "Tags": {
          "Tag": [
            {
              "Key": "TestKey",
              "Value": "TestValue"
            }
          ]
        },
        "Disks": {
          "System": {
            "Size": 100,
            "LVM": false,
            "DiskId": "d-2zeh4twm100qskw7z41z",
            "Parts": {
              "Part": [
                {
                  "SizeBytes": 21474836480,
                  "Block": true,
                  "Path": "/boot"
                }
              ]
            }
          },
          "Data": {
            "Data": [
              {
                "Size": 22548578304,
                "LVM": false,
                "DiskId": "d-2zeh4twm100qskw7z41z",
                "Parts": {
                  "Part": [
                    {
                      "SizeBytes": 21474836480,
                      "Block": false,
                      "Path": "/home/data\n"
                    }
                  ]
                }
              }
            ]
          }
        },
        "WorkgroupId": "w-bp1ja22kdqphehlj****"
      }
    ]
  },
  "PageSize": 10,
  "RequestId": "6E1187E8-843A-4850-B97E-2F17F00D48F7",
  "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.	使用者未授權操作指定的資源。

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

變更歷史

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