調用CreateReplicationJob為遷移源創建一個遷移任務。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
smc:CreateReplicationJob | create |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
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 | 否 | 已配置高速通道服務或者 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 可查詢云服務器 ECS 提供的實例規格。
| ecs.c6.large |
LaunchTemplateId | string | 否 | 實例啟動模板 ID。 | lt-bp16jovvln1cgaaq**** |
LaunchTemplateVersion | string | 否 | 實例啟動模板的版本。 | 1 |
InstanceRamRole | string | 否 | 實例 RAM 角色名稱。 | SMCAdmin |
ContainerNamespace | string | 否 | Docker 的命名空間。關于 Docker 容器鏡像詳情請參見容器鏡像服務。 | testNamespace |
ContainerRepository | string | 否 | Docker 的鏡像倉庫。關于 Docker 容器鏡像詳情請參見容器鏡像服務。 | testRepository |
ContainerTag | string | 否 | Docker 的鏡像標簽。關于 Docker 容器鏡像詳情請參見容器鏡像服務。 | CentOS:v1 |
LicenseType | string | 否 | BYOL | |
DataDisk | array<object> | 否 | 數據盤信息列表。 | |
object | 否 | 數據盤信息列表。 | ||
Index | integer | 否 | 目標阿里云服務器 ECS 的數據盤順序。初始值為 1。取值范圍:1~16 說明
您只能為遷移源中存在的數據盤創建目標數據盤。
| 1 |
Part | array<object> | 否 | 分區列表。 | |
object | 否 | 分區列表。 | ||
SizeBytes | long | 否 | 目標數據盤 N 分區 N 的大小。單位:Byte。默認為源數據盤分區大小。 說明
| 254803968 |
Block | boolean | 否 | 數據盤 N 分區 N 是否開啟塊復制。取值范圍:
默認值:true。 | true |
Device | string | 否 | 目標數據盤 N 分區 N 對應的分區設備標識。N 的實際取值請參考遷移源的分區設備標識。 說明
當 DataDisk.N.Part.N.SizeBytes 不為空時,該參數也不能為空。
| 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 | long | 否 | 系統盤分區 N 大小。單位:Byte。默認為源系統盤分區大小。 說明
| 254803968 |
Block | boolean | 否 | 系統盤分區 N 是否開啟塊復制。取值范圍:
默認值:true。 | true |
Device | string | 否 | 目標系統盤分區 N 設備標識。N 的實際取值請參考遷移源的分區設備標識。 說明
當 SystemDiskPart.N.SizeBytes 不為空時,該參數也不能為空。
| 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 | long | 否 | 系統盤分區大小。單位:Byte。 | 254803968 |
Block | boolean | 否 | 系統盤分區是否開啟塊復制。 | true |
Path | string | 否 | 系統盤分區路徑。 | /boot |
Data | array<object> | 否 | 數據盤分區信息。 | |
object | 否 | 數據盤分區信息。 | ||
Size | integer | 否 | 遷移源的數據磁盤大小。單位:GiB。 | 80 |
LVM | boolean | 否 | 數據盤是否使用 LVM。取值:
| |
DiskId | string | 否 | 數據盤 ID。 | d-2ze8hyowhdgd6ou2m5z6 |
Part | array<object> | 否 | 數據盤分區信息。 | |
object | 否 | 數據盤分區信息。 | ||
SizeBytes | long | 否 | 數據盤分區大小。單位:Byte。 | 21474836480 |
Block | boolean | 否 | 數據盤分區是否開啟塊復制。取值:
| true |
Path | string | 否 | 數據盤分區路徑。 | /home/date |
返回參數
示例
正常返回示例
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。 |
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. | 賬戶未實名認證,請先進行實名認證 |
500 | InternalError | An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket. | 內部錯誤,請重試。如果多次嘗試失敗,請提交工單。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-09-27 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2024-03-28 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |