調用ModifyReplicationJobAttribute修改遷移任務信息。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀?。≧ead)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
smc:ModifyReplicationJobAttribute | update |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
JobId | string | 是 | 遷移任務 ID。 | j-bp19vlwm0tyigbmj**** |
Name | string | 否 | 遷移任務名稱。遷移任務的名稱需滿足以下要求:
| testMigrationTaskName |
Description | string | 否 | 遷移任務描述。 長度應為 2~128 個英文或中文字符,必須以大小寫字母或中文開頭,不能以 | This_is_my_migration_task |
TargetType | string | 否 | 遷移交付的目標類型。僅支持在遷移任務啟動前修改。取值范圍:
說明
| 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 | 否 | 遷移任務交付的目標鏡像名稱。目標鏡像的名稱需滿足以下要求:
說明
如果遷移任務運行過程中,當前地域已經存在相同名稱的鏡像,則系統默認在鏡像名稱后面添加遷移任務 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。
| 10 |
MaxNumberOfImageToKeep | integer | 否 | 增量遷移任務默認保留的最大鏡像數。取值范圍為 1~10。
| 5 |
InstanceType | string | 否 | 中轉實例的實例規格。 調用 DescribeInstanceTypes 可查詢云服務器 ECS 提供的實例規格。
| ecs.c5.large |
LaunchTemplateId | string | 否 | 實例啟動模板 ID。 | lt-bp16jovvln1cgaaq**** |
LaunchTemplateVersion | string | 否 | 實例啟動模板的版本。 | Latest |
InstanceRamRole | string | 否 | 實例 RAM 角色名稱。 | SMCAdmin |
ContainerNamespace | string | 否 | Docker 的命名空間。關于 Docker 容器鏡像詳情請參見容器鏡像服務。 | testNamespace |
ContainerRepository | string | 否 | Docker 的鏡像倉庫。關于 Docker 容器鏡像詳情請參見容器鏡像服務。 | testRepository |
ContainerTag | string | 否 | Docker 的鏡像標簽。關于 Docker 容器鏡像詳情請參見容器鏡像服務。 | CentOS:v1 |
ValidTime | string | 否 | 遷移任務的過期時間。取值范圍:遷移任務創建時間+7 天~遷移任務創建時間+90 天
默認值:遷移任務創建時間+30 天(表示遷移任務的默認有效期為創建后 30 天)。 | 2019-06-04T13:35:00Z |
SystemDiskPart | array<object> | 否 | 系統盤分區列表。 | |
object | 否 | 系統盤分區列表。 | ||
SizeBytes | long | 否 | 目標系統盤分區 N 大小。單位:Byte。默認為源系統盤分區大小。 說明
分區空間大小不能超過系統盤空間大小,并且在系統盤下所有分區空間大小之和不能超過系統盤空間大小。
| 254803968 |
Block | boolean | 否 | 目標系統盤分區 N 是否開啟塊復制。取值范圍:
| true |
Device | string | 否 | 目標系統盤分區 N 設備標識。 說明
N 的實際取值請參考遷移源的分區設備標識。
| 0_1 |
DataDisk | array<object> | 否 | 數據盤列表。 | |
object | 否 | 數據盤列表。 | ||
Index | integer | 否 | 目標阿里云服務器 ECS 的數據盤順序。取值范圍為 1~16。 初始值為 1。 說明
您只能為源服務器中存在的數據盤創建目標數據盤。
| 1 |
Part | array<object> | 否 | 分區列表。 | |
object | 否 | 分區列表。 | ||
SizeBytes | long | 否 | 目標數據盤 N 分區 N 的大小。單位:Byte。默認為源數據盤分區大小。 說明
分區空間大小不能超過數據盤空間大小,并且在同一數據盤下所有分區空間大小之和不能超過數據盤空間大小。
| 254803968 |
Block | boolean | 否 | 目標數據盤 N 分區 N 是否開啟塊復制。取值范圍:
| true |
Device | string | 否 | 目標數據盤 N 分區 N 對應的分區設備標識。 說明
N 的實際取值請參考遷移源的分區設備標識。
| 0_1 |
Size | integer | 否 | 目標阿里云服務器 ECS 的數據盤大小,單位:GiB。取值范圍為 20~32768。 說明
參數取值需要大于源服務器數據盤實際占用大小。例如,源數據盤大小為 500 GiB,實際占用 100 GiB,則該參數取值需大于 100 GiB。
| 100 |
NetMode | integer | 否 | 數據傳輸網絡模式。取值范圍:
| 0 |
VSwitchId | string | 否 | 指定 VPC 下的虛擬交換機 ID。 | vsw-bp1ddbrxdlrcbim46**** |
VpcId | string | 否 | 已配置高速通道服務或者 VPN 網關的 VPC ID。 | vpc-bp1vwnn14rqpyiczj**** |
ReplicationParameters | string | 否 | 復制驅動器的參數信息。參數信息為 JSON 格式鍵值對,鍵值固定。最大長度:2048 個字符。 復制驅動器是指,復制源服務器數據到中轉實例時所使用的工具。不同復制驅動器支持參數可能不同。復制驅動器 SMT 目前支持以下參數:
復制驅動器的取值,請參見 DescribeSourceServers 的返回參數 | {"bandwidth_limit":0,"compress_level":1,"checksum":true} |
返回參數
示例
正常返回示例
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. | 內部錯誤,請重試。如果多次嘗試失敗,請提交工單。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-03-22 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-01-22 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2024-01-19 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |