全部產品
Search
文件中心

Server Migration Center:ModifyReplicationJobAttribute - 修改遷移任務

更新時間:Sep 08, 2025

調用ModifyReplicationJobAttribute修改遷移任務資訊。

介面說明

介面說明

修改遷移任務之前,請閱讀以下注意事項:

  • 參數Name和Description在遷移任務的整個生命週期內均可以修改。

  • 參數Frequency和MaxNumberOfImageToKeep只能在遷移任務執行前或任務狀態為等待中時修改。

  • 其他參數只能在遷移任務執行前修改。

調試

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

調試

授權資訊

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

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

smc:ModifyReplicationJobAttribute

update

*ReplicationJob

acs:smc:{#regionId}:{#accountId}:replicationjob/{#JobId}

無 無

請求參數

名稱

類型

必填

描述

樣本值

JobId

string

是

遷移任務 ID。

j-bp19vlwm0tyigbmj****

Name

string

否

遷移任務名稱。遷移任務的名稱需滿足以下要求:

  • 任務名稱必須唯一。

  • 長度為 2~128 個英文或中文字元,必須以大小寫字母或中文開頭,不能以http://和https://開頭,可以包含數字、半形冒號(:)、底線(_)或者短劃線(-)。

testMigrationTaskName

Description

string

否

遷移任務描述。

長度應為 2~128 個英文或中文字元,必須以大小寫字母或中文開頭,不能以http://和https://開頭,可以包含數字、半形冒號(:)、底線(_)或者短劃線(-)。

This_is_my_migration_task

TargetType

string

否

遷移交付的目標類型。僅支援在遷移任務啟動前修改。取值範圍:

  • Image:遷移成功後,SMC 為您的原始伺服器產生阿里雲鏡像,您可使用該鏡像建立 ECS 執行個體達到遷移至阿里雲的目的。

  • ContainerImage:遷移成功後,SMC 為您的原始伺服器產生容器鏡像,您可以在Container Registry中使用該鏡像。

  • TargetInstance:遷移成功後,SMC 將您的遷移源隨即轉移至目標執行個體。當您設定該參數值時,您需要同時指定InstanceId參數。

說明
  • 該參數的取值不區分大小寫。

  • Windows 作業系統和 Arm 架構作業系統不支援遷移至容器鏡像。

Image

ScheduledStartTime

string

否

設定遷移任務的執行時間。SMC 在指定時間自動為您啟動遷移任務。

執行時間遵循 ISO8601 標準,並需要使用 UTC 時間,格式為 YYYY-MM-DDThh:mm:ssZ。例如,2018-01-01T12:00:00Z,表示北京時間 2018 年 01 月 01 日 20 點 00 分 00 秒。

說明

當執行時間為空白時,SMC 不自動啟動遷移任務,您需要調用 StartReplicationJob 啟動。

2019-06-04T13:35:00Z

ImageName

string

否

遷移任務交付的目標鏡像名稱。目標鏡像的名稱需滿足以下要求:

  • 同一阿里雲地區下,鏡像名稱必須唯一。

  • 長度為 2~128 個英文或中文字元,必須以大小寫字母或中文開頭,不能以http://和https://開頭,可以包含數字、半形冒號(:)、底線(_)或者短劃線(-)。

說明

如果遷移任務運行過程中,當前地區已經存在相同名稱的鏡像,則系統預設在鏡像名稱後面添加遷移任務 ID(JobId)作為尾碼,如:ImageName-JobId。

testAliCloudImageName

InstanceId

string

否

目標執行個體 ID。

i-bp1f1dvfto1sigz5****

SystemDiskSize

integer

否

目標阿里雲伺服器 ECS 的系統硬碟大小,單位:GiB。取值範圍為 20~500。

說明

參數取值需要大於原始伺服器系統硬碟實際佔用大小,例如,源系統硬碟大小為 500 GiB,實際佔用 100 GiB,則該參數取值需大於 100 GiB。

50

Frequency

integer

否

增量遷移任務啟動並執行時間間隔,單位:小時。取值範圍為 1~168。

RunOnce參數值為 false 時,該參數為必填參數。

10

MaxNumberOfImageToKeep

integer

否

增量遷移任務預設保留的最大鏡像數。取值範圍為 1~10。

RunOnce參數值為 false 時,該參數為必填參數。

5

InstanceType

string

否

中轉執行個體的執行個體規格。

調用 DescribeInstanceTypes 可查詢Elastic Compute Service 提供的執行個體規格。

  • 指定該參數後,系統會選擇該執行個體規格建立中轉執行個體。若該執行個體規格庫存不足,則遷移任務建立失敗。

  • 不指定該參數時,系統會預設按照一定順序選擇執行個體規格來建立中轉執行個體,詳情請參見SMC FAQ 中轉執行個體規格有哪些。

ecs.c5.large

LaunchTemplateId

string

否

執行個體啟動模板 ID。

lt-bp16jovvln1cgaaq****

LaunchTemplateVersion

string

否

執行個體啟動模板的版本。

Latest

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

ValidTime

string

否

遷移任務的到期時間。取值範圍:遷移任務建立時間+7 天~遷移任務建立時間+90 天

  • 到期時間只允許遷移任務在 Ready(未開始)、Running(運行中)、Stopped(已暫停)、InError(出錯)或 Waiting(等待中)狀態下修改。

  • 到期時間須遵循 ISO8601 標準,並需要使用 UTC+0 時間,格式為YYYY-MM-DDThh:mm:ssZ。例如,2018-01-01T12:00:00Z,表示北京時間 2018 年 01 月 01 日 20 點 00 分 00 秒。

  • 到期時間設定為空白,表示任務無限期有效。

  • 任務到期後會被標記為到期狀態,儲存 7 天,7 天后系統會自動清理。

預設值:遷移任務建立時間+30 天(表示遷移任務的預設有效期間為建立後 30 天)。

2019-06-04T13:35:00Z

SystemDiskPart

array<object>

否

系統硬碟分區列表。

object

否

系統硬碟分區列表。

SizeBytes

integer

否

目標系統硬碟分區 N 大小。單位:Byte。預設為源系統硬碟分區大小。

說明

分區空間大小不能超過系統硬碟空間大小,並且在系統硬碟下所有分區空間大小之和不能超過系統硬碟空間大小。

254803968

Block

boolean

否

目標系統硬碟分區 N 是否開啟塊複製。取值範圍:

  • true。

  • false。

true

Device

string

否

目標系統硬碟分區 N 裝置標識。

說明

N 的實際取值請參考遷移源的分區裝置標識。

0_1

DataDisk

array<object>

否

資料盤列表。

array<object>

否

資料盤列表。

Index

integer

否

目標阿里雲伺服器 ECS 的資料盤順序。取值範圍為 1~16。

初始值為 1。

說明

您只能為原始伺服器中存在的資料盤建立目標資料盤。

1

Part

array

否

分區列表。

object

否

分區列表。

SizeBytes

integer

否

目標資料盤 N 分區 N 的大小。單位:Byte。預設為來源資料盤分區大小。

說明

分區空間大小不能超過資料盤空間大小,並且在同一資料盤下所有分區空間大小之和不能超過資料盤空間大小。

254803968

Block

boolean

否

目標資料盤 N 分區 N 是否開啟塊複製。取值範圍:

  • true。

  • false。

true

Device

string

否

目標資料盤 N 分區 N 對應的分區裝置標識。

說明

N 的實際取值請參考遷移源的分區裝置標識。

0_1

Size

integer

否

目標阿里雲伺服器 ECS 的資料盤大小,單位:GiB。取值範圍為 20~32768。

說明

參數取值需要大於原始伺服器資料盤實際佔用大小。例如,來源資料盤大小為 500 GiB,實際佔用 100 GiB,則該參數取值需大於 100 GiB。

100

NetMode

integer

否

資料轉送網路模式。取值範圍:

  • 0:表示公網傳輸模式。此時要求您的原始伺服器能夠訪問公網,遷雲資料從公網傳輸。

  • 2:表示內網傳輸模式,選用此模式必須設定 VSwitchId 參數(VpcId 參數可以不設定,服務內部可以通過介面反查出來)。

0

VSwitchId

string

否

指定 VPC 下的虛擬交換器 ID。

vsw-bp1ddbrxdlrcbim46****

VpcId

string

否

已配置Express Connect服務或者 VPN 閘道的 VPC ID。

vpc-bp1vwnn14rqpyiczj****

ReplicationParameters

string

否

複製磁碟機的參數資訊。參數資訊為 JSON 格式索引值對,索引值固定。最大長度:2048 個字元。

複製磁碟機是指,複製原始伺服器資料到中轉執行個體時所使用的工具。不同複製磁碟機支援參數可能不同。複製磁碟機 SMT 目前支援以下參數:

  • bandwidth_limit:傳輸速度頻寬節流設定。

  • compress_level:傳輸壓縮率。

  • checksum:是否開啟 checksum 校正。

複製磁碟機的取值,請參見 DescribeSourceServers 的返回參數SourceServers.ReplicationDriver。

{"bandwidth_limit":0,"compress_level":1,"checksum":true}

返回參數

名稱

類型

描述

樣本值

object

RequestId

string

請求 ID。

1C488B66-B819-4D14-8711-C4EAAA13AC01

樣本

正常返回樣本

JSON格式

{
  "RequestId": "1C488B66-B819-4D14-8711-C4EAAA13AC01"
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

400 DataDisk.DuplicateIndex The source server data disk cannot contain the same index. 遷移來源資料盤包含相同的索引,請檢查磁碟索引是否重複。
400 ReplicationJobDataDiskIndex.Invalid The specified replication job contains data disk index not found in source server. 遷移任務包含的資料盤索引在遷移源中不存在。
400 ReplicationJobName.Duplicate The specified replication job name already exists. 遷移任務名稱已存在,請修改遷移任務名稱。
400 ReplicationJob.InvalidStatus The specified replication job status: %s is invalid. This operation can only be performed in the following status: %s. 遷移任務的狀態:%s 是無效的。該操作只能在以下狀態進行:%s。
400 ReplicationJob.InvalidBusinessStatus The specified business status: %s of the replication job 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”被當前地區的另一個遷移任務使用。
500 InternalError An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket. 內部錯誤,請重試。如果多次嘗試失敗,請提交工單。

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

變更歷史

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