調用CreateReplicationJob為遷移源建立一個遷移任務。
介面說明
介面說明
您只能為線上(Available)狀態的遷移源建立遷移任務。
每個遷移源僅能關聯一個未完成狀態的遷移任務。未完成狀態包括 Ready(未開始)、Running(運行中)、Stopped(已暫停)、Waiting(等待中)、InError(出錯)和 Expired(已到期)。
每個阿里雲帳號可建立 1000 個遷移任務。
遷移目標類型為鏡像時,需指定 ImageName、SystemDiskSize、DataDisk 參數。
使用 VPC 內網遷移時,VSwitchId 參數為必填,VpcId 參數為可選。
支援遷移源的遷移目標為 Docker 容器鏡像,實現低成本容器化應用遷移。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
smc:CreateReplicationJob |
create |
*ReplicationJob
*SourceServer
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| RegionId |
string |
是 |
遷移源要遷入的目標阿里雲地區 ID。 例如,您需要遷移原始伺服器至杭州,則相應的阿里雲地區 ID 為 |
cn-hangzhou |
| ClientToken |
string |
否 |
保證請求等冪性。您可以從用戶端產生一個不超過 64 個 ASCII 字元的參數值,並將值賦予 ClientToken,保證重試請求的等冪性。更多詳情,請參見如何保證等冪性。 |
123e4567-e89b-12d3-a456-426655440000 |
| Name |
string |
否 |
遷移任務名。遷移任務的名稱需滿足以下要求:
|
testMigrationTaskName |
| Description |
string |
否 |
遷移任務描述。 長度應為 2~128 個英文或中文字元,必須以大小字母或中文開頭,不能以 |
This_is_a_migration_task |
| SourceId |
string |
是 |
遷移源 ID。 |
s-bp1e2fsl57knvuug**** |
| TargetType |
string |
否 |
遷移任務交付的目標類型。取值範圍:
|
Image |
| ScheduledStartTime |
string |
否 |
遷移任務的執行時間。該參數值的設定需滿足以下要求:
說明
如果該參數值為空白,則 SMC 不會啟動遷移任務,需要您調用 StartReplicationJob 啟動任務。 |
2019-06-04T13:35:00Z |
| ValidTime |
string |
否 |
遷移任務的到期時間。取值範圍:遷移任務建立時間+7 天~遷移任務建立時間+90 天。
預設值:遷移任務建立時間+30 天(表示遷移任務的預設有效期間為建立後 30 天)。 |
2019-06-04T13:35:00Z |
| ImageName |
string |
否 |
遷移任務交付的目標阿里雲鏡像名稱。目標鏡像的名稱需滿足以下要求:
說明
遷移任務運行過程中,若當前地區已經存在相同名稱的鏡像,則系統預設給鏡像名稱添加遷移任務 ID(JobId)作為尾碼,如:ImageName_j-2zexxxxxxxxxxxxx。 |
testAliCloudImageName |
| InstanceId |
string |
否 |
目標執行個體 ID。 |
i-bp1f1dvfto1sigz5**** |
| SystemDiskSize |
integer |
否 |
目標阿里雲伺服器 ECS 的系統硬碟大小,單位為 GiB。取值範圍:20~2048。 說明
該參數取值需要大於遷移源系統硬碟實際佔用大小,例如,源系統硬碟大小為 500 GiB,實際佔用 100 GiB,則該參數取值需大於 100 GiB。 |
80 |
| VpcId |
string |
否 |
已配置Express Connect服務或者 VPN 閘道的 VPC ID。 |
vpc-bp1vwnn14rqpyiczj**** |
| VSwitchId |
string |
否 |
指定 VPC 下的虛擬交換器 ID。 使用 VPC 內網遷移時,該參數為必填參數。 |
vsw-bp1ddbrxdlrcbim46**** |
| ReplicationParameters |
string |
否 |
複製磁碟機的參數資訊。參數資訊為 JSON 格式索引值對,索引值固定。最大長度:2048 個字元。 複製磁碟機是指,複製原始伺服器資料到中轉執行個體時所使用的工具。不同複製磁碟機支援參數可能不同。複製磁碟機 SMT 目前支援以下參數:
複製磁碟機的取值,請參見 DescribeSourceServers 的返回參數 |
{"bandwidth_limit":0,"compress_level":1,"checksum":true} |
| NetMode |
integer |
否 |
資料轉送網路模式。取值範圍:
預設值:0。 |
0 |
| RunOnce |
boolean |
否 |
建立一次性遷移任務還是增量遷移任務。取值範圍:
說明
該參數值只能在建立遷移任務時指定。參數值一經指定,則無法更改。 |
true |
| Frequency |
integer |
否 |
增量遷移任務啟動並執行時間間隔,單位:小時。取值範圍:1~168。
預設值:無。 |
12 |
| MaxNumberOfImageToKeep |
integer |
否 |
增量遷移任務預設保留的最大鏡像數。取值範圍:1~10。
預設值:無。 |
10 |
| InstanceType |
string |
否 |
中轉執行個體的執行個體規格。 調用 DescribeInstanceTypes 可查詢Elastic Compute Service 提供的執行個體規格。
|
ecs.c6.large |
| LaunchTemplateId |
string |
否 |
執行個體啟動模板 ID。 |
lt-bp16jovvln1cgaaq**** |
| LaunchTemplateVersion |
string |
否 |
執行個體啟動模板的版本。 |
1 |
| InstanceRamRole |
string |
否 |
執行個體 RAM 角色名稱。 |
SMCAdmin |
| ContainerNamespace |
string |
否 |
Docker 的命名空間。關於 Docker 容器鏡像詳情請參見Container Registry。 |
testNamespace |
| ContainerRepository |
string |
否 |
Docker 的鏡像倉庫。關於 Docker 容器鏡像詳情請參見Container Registry。 |
testRepository |
| ContainerTag |
string |
否 |
Docker 的鏡像標籤。關於 Docker 容器鏡像詳情請參見Container Registry。 |
CentOS:v1 |
| LicenseType |
string |
否 |
許可證類型。取值範圍:
更多資訊,請參見SMC FAQ。 |
BYOL |
| DataDisk |
array<object> |
否 |
資料盤資訊列表。 |
|
|
array<object> |
否 |
資料盤資訊列表。 |
||
| Index |
integer |
否 |
目標阿里雲伺服器 ECS 的資料盤順序。初始值為 1。取值範圍:1~16 說明
您只能為遷移源中存在的資料盤建立目標資料盤。 |
1 |
| Part |
array<object> |
否 |
分區列表。 |
|
|
object |
否 |
分區列表。 |
||
| SizeBytes |
integer |
否 |
目標資料盤 N 分區 N 的大小。單位:Byte。預設為來源資料盤分區大小。 說明
|
254803968 |
| Block |
boolean |
否 |
資料盤 N 分區 N 是否開啟塊複製。取值範圍:
預設值:true。 |
true |
| Device |
string |
否 |
目標資料盤 N 分區 N 對應的分區裝置標識。N 的實際取值請參考遷移源的分區裝置標識。 說明
當 |
0_1 |
| Size |
integer |
否 |
目標阿里雲伺服器 ECS 的資料盤大小,單位為 GiB。取值範圍:20~32768。 說明
該參數取值需要大於遷移來源資料盤實際佔用大小。例如,來源資料盤大小為 500 GiB,實際佔用 100 GiB,則該參數取值需大於 100 GiB。 |
100 |
| Tag |
array<object> |
否 |
標籤列表。 |
|
|
object |
否 |
標籤列表。 |
||
| Key |
string |
否 |
遷移任務的標籤鍵。N 的取值範圍:1~20 一旦傳入該值,則不允許為空白字串。最多支援 128 個字元,不能以 |
TestKey |
| Value |
string |
否 |
遷移任務的標籤值。N 的取值範圍:1~20。 一旦傳入該值,可以為空白字串。最多支援 128 個字元,不能以 |
TestValue |
| SystemDiskPart |
array<object> |
否 |
系統硬碟分區資訊。 |
|
|
object |
否 |
系統硬碟分區列表。 |
||
| SizeBytes |
integer |
否 |
系統硬碟分區 N 大小。單位:Byte。預設為源系統硬碟分區大小。 說明
|
254803968 |
| Block |
boolean |
否 |
系統硬碟分區 N 是否開啟塊複製。取值範圍:
預設值:true。 |
true |
| Device |
string |
否 |
目標系統硬碟分區 N 裝置標識。N 的實際取值請參考遷移源的分區裝置標識。 說明
當 |
0_1 |
| JobType |
integer |
否 |
遷移任務的類型。取值範圍:
|
0 |
| ResourceGroupId |
string |
否 |
資源群組 ID。 |
rg-acfmw3ty5y7**** |
| Disks |
object |
否 |
磁碟資訊。 |
|
| System |
object |
否 |
系統硬碟資訊。 |
|
| Size |
integer |
否 |
遷移源系統硬碟的大小,單位:GiB。取值範圍為 20~32768。 說明
參數取值需要大於原始伺服器資料盤實際佔用大小。例如,來源資料盤大小為 500 GiB,實際佔用 100 GiB,則該參數取值需大於 100 GiB。 |
100 |
| LVM |
boolean |
否 |
是否使用 LVM。取值:
不支援開啟 LVM:
開啟 LVM 後,以下情境該功能不生效:
|
true |
| Part |
array<object> |
否 |
系統硬碟分區資訊。 |
|
|
object |
否 |
系統硬碟分區資訊。 |
||
| SizeBytes |
integer |
否 |
系統硬碟分區大小。單位:Byte。 |
254803968 |
| Block |
boolean |
否 |
系統硬碟分區是否開啟塊複製。 |
true |
| Path |
string |
否 |
系統硬碟分區路徑。 |
/boot |
| Data |
array<object> |
否 |
資料盤分區資訊。 |
|
|
array<object> |
否 |
資料盤分區資訊。 |
||
| Size |
integer |
否 |
遷移源的資料磁碟大小。單位:GiB。 |
80 |
| LVM |
boolean |
否 |
資料盤是否使用 LVM。取值:
|
|
| DiskId |
string |
否 |
資料盤 ID。 |
d-2ze8hyowhdgd6ou2m5z6 |
| Part |
array<object> |
否 |
資料盤分區資訊。 |
|
|
object |
否 |
資料盤分區資訊。 |
||
| SizeBytes |
integer |
否 |
資料盤分區大小。單位:Byte。 |
21474836480 |
| Block |
boolean |
否 |
資料盤分區是否開啟塊複製。取值:
|
true |
| Path |
string |
否 |
資料盤分區路徑。 |
/home/date |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回參數資訊。 |
||
| RequestId |
string |
請求 ID。 |
C8B26B44-0189-443E-9816-D951F59623A9 |
| JobId |
string |
遷移任務 ID。 |
j-bp17bclvg344jlyt**** |
樣本
正常返回樣本
JSON格式
{
"RequestId": "C8B26B44-0189-443E-9816-D951F59623A9",
"JobId": "j-bp17bclvg344jlyt****"
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | ReplicationJobDataDiskIndex.Invalid | The specified replication job contains data disk index not found in source server. | 遷移任務包含的資料盤索引在遷移源中不存在。 |
| 400 | VSwitchIdVpcId.Mismatch | The specified VSwitchId and VpcId does not match. | 指定的VSwitchId和VpcId不匹配。 |
| 400 | InvalidSecurityGroupId.IncorrectNetworkType | The network type of the specified security group does not support this action. | 安全性群組網路類型不支援該操作,請檢查安全性群組網路類型。 |
| 400 | InvalidSecurityGroupId.VPCMismatch | The specified security group and the specified virtual switch are not in the same VPC. | 指定的安全性群組和交換器不在一個專用網路。 |
| 400 | QuotaExceeded.ReplicationJob | The maximum number of replication jobs is exceeded. Please submit a ticket to raise the quota. | 遷移任務的數量已超過最大允許值,請提交工單。 |
| 400 | ReplicationJobName.Duplicate | The specified replication job name already exists. | 遷移任務名稱已存在,請修改遷移任務名稱。 |
| 400 | SourceServerState.Invalid | The specified source server status: %s is invalid. This operation can only be performed in the following status: %s. | 遷移源的狀態:%s 是無效的。該操作只能在以下狀態進行:%s。 |
| 400 | ImageName.UsedByReplicationJob | The specified imageName: "%s" was used by another replication job in the current region. | 鏡像名稱“%s”被當前地區的另一個遷移任務使用。 |
| 400 | InvalidOsMigrationType.NotMatched | The SourceOsType: %s and TargetOsType: %s are not matched. The supported TargetOsType list is: %s. | 源作業系統類型:%s 和目標作業系統類型:%s 不匹配。支援的目標作業系統類型列表是:%s。 |
| 500 | InternalError | An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket. | 內部錯誤,請重試。如果多次嘗試失敗,請提交工單。 |
| 403 | EntityNotExist.Role | The account is unauthorized. Please assign the role AliyunServiceRoleForSMC to your account. | 帳號不具備操作許可權,請賦予賬戶AliyunServiceRoleForSMC角色。 |
| 403 | RealNameAuthenticationError | You must perform real-name verification for your account. | 賬戶未實名認證,請先進行實名認證 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。