創建對象存儲遷移任務
更新時間 2025-06-11 14:55:32
最近更新時間: 2025-06-11 14:55:32
分享文章
接口功能介紹
創建對象存儲遷移任務
接口約束
1、支持的線上資源池 :華東1
2、單個用戶可創建最多5個任務
URI
POST /v4/zms/create-migration
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 資源池 ID | 332232xxxxx5123866f0 | |
| migrationName | 是 | String | 任務名稱,必須為大小寫字母、數字、橫線或下劃線,長度在4-32個字符之間,且名稱不能重復 | cxx-hkpblz-bbt | |
| sourceInfo | 是 | Array of Objects | 源端信息 | 參考表sourceInfo | |
| destinationInfo | 是 | Array of Objects | 目的端信息 | 參考表destinationInfo | |
| storageType | 否 | String | 遷移到目的端存儲類型,默認為標準存儲。①MATCH_RESOURCE:匹配源端,匹配源端存儲類型時,僅能自動匹配源端的“標準”和“低頻”類型;匹配源端的“歸檔”或“深度歸檔”類型,請您務必提前對源端歸檔數據進行手動解凍,并確保遷移任務完成前數據保持解凍狀態,否則該部分數據會遷移失敗;②STANDARD:標準存儲;③STANDARD_IA:低頻存儲;④GLACIER:歸檔存儲 | STANDARD | |
| aclConf | 否 | String | 目的端ACL配置,默認為匹配源端,①match-resource:匹配源端;②private:私有;③public-read:公共讀 | match-resource | |
| conflictMode | 否 | String | 同名文件處理選項,默認為IGNORE,①OVERWRITE:同名文件進行覆蓋; ②IGNORE:同名文件進行忽略;③COMPARE:同名文件按最后修改時間(即LastModified)比較,若源端LastModified小于目的端LastModified,則此文件被執行跳過;若源端LastModified大于目的端LastModified,則執行覆蓋;若源端與目的端文件LastModified一致,則判斷兩者的文件大小,大小一致則執行跳過,大小不一致則執行覆蓋。 | IGNORE | |
| migrateStartTime | 否 | String | 遷移晚于起始時間的對象,該選項會遷移最后修改時間(即LastModified)晚于指定時間的對象。可以設置兩種格式"year-month-day hour:minute:second"或"year-month-day"。可填時間范圍限制為[1970-01-02 00:00:00,2037-12-31 23:59:59],若同時填入migrateStartTime和migrateEndTime,則migrateStartTime值應小于migrateEndTime。 | 1970-01-04 08:00:00 | |
| migrateEndTime | 否 | String | 遷移早于終止時間的對象,該選項會遷移最后修改時間(即LastModified)早于指定時間的對象。可以設置兩種格式"year-month-day hour:minute:second"或"year-month-day",默認為當前任務創建時間加10年。。可填時間范圍限制為[1970-01-02 00:00:00,2037-12-31 23:59:59],若同時填入migrateStartTime和migrateEndTime,則migrateStartTime值應小于migrateEndTime。 | 2025-01-01 08:00:00 |
表 sourceInfo
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| sourceType | 否 | String | 遷移源類型,默認為S3,①S3:亞馬遜;②OSS:阿里云; ③COS:騰訊云;④ OBS:華為云;⑤ OOS:天翼云⑥ZOS:天翼云對象存儲 | S3 | |
| sourceEndpoint | 是 | String | 遷移資源池地址,支持輸入IP或域名,以//或//開頭。如需使用非默認端口,請輸入端口號 | //xxx:8888或//xxx | |
| sourceBucket | 是 | String | 遷移源桶,輸入限制不超過1024字符 | bucket-kpblz | |
| sourceAccessKey | 是 | String | 遷移源資源池ak,輸入限制不超過1024字符 | XXXXXX | |
| sourceSecretKey | 是 | String | 遷移源資源池sk,輸入限制不超過1024字符 | XXXXXX | |
| sourceBucketType | 否 | String | 源資源池遷移模式,默認為Bucket。①Bucket:整桶遷移;②Folder:文件夾遷移;③Files:文件遷移;④Prefix:前綴遷移 | Bucket | |
| migrateFolder | 否 | Array of Strings | 指定源資源池遷移的文件夾列表,僅當sourceBucketType為Folder時有效,當前僅支持指定單個文件夾,單個文件夾名輸入限制不超過1024字符 | ["folder1"] | |
| migrateFiles | 否 | Array of Strings | 指定源資源池遷移的文件名列表,僅當sourceBucketType為Files時有效,當前指定文件上限為100個,單個對象名輸入限制不超過1024字符 | ["files1","files2"] | |
| migratePrefix | 否 | Array of Strings | 指定源資源池遷移的前綴列表,僅當sourceBucketType為Prefix時有效,當前只支持指定單個前綴,單個前綴名輸入限制不超過1024字符 | ["prefix1"] |
表 destinationInfo
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| destinationType | 否 | String | 目的端類型,目前默認且僅支持ZOS | ZOS | |
| destinationEndpoint | 是 | String | 目的資源池地址,支持輸入IP或域名,以//或//開頭。如需使用非默認端口,請輸入端口號 | //xxx | |
| destinationBucket | 是 | String | 目的資源池桶,輸入限制不超過1024字符 | bucket-haha | |
| destinationAccessKey | 是 | String | 目的資源池ak,輸入限制不超過1024字符 | XXXXXX | |
| destinationSecretKey | 是 | String | 目的資源池sk,輸入限制不超過1024字符 | XXXXXX |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼(800為成功,900為處理中/失敗) | 800 | |
| message | String | 狀態描述 | SUCCESS | |
| returnObj | Object | 響應對象 | 參考表returnObj | |
| description | String | 狀態描述,一般為中文 | 成功 | |
| errorCode | String | 業務細分碼(僅失敗時具有此參數),為product.module.code三段式碼 | openapi.userPermission.accessFailed | |
| error | String | 業務細分碼(大駝峰形式,僅失敗時具有此參數),為 Product.Module.Code 三段式碼 | Openapi.UserPermission.AccessFailed |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| result | String | 任務結果 | success | |
| migrationID | String | 遷移任務ID,作為其他操作(詳情、重試、暫停、恢復、刪除)參數中的migrationID傳入 | xxx |
枚舉參數
無
請求示例
請求url
無
請求頭header
無
請求體body
{
"regionID": "81f77286xxxx0800155d307d5b",
"migrationName":"aanjyy",
"storageType":"STANDARD",
"aclConf":"match-resource",
"conflictMode":"IGNORE",
"migrateStartTime":"2017-12-31 23:59:59",
"migrateEndTime":"2027-12-31 23:59:59",
"sourceInfo":[{
"sourceType":"ZOS",
"sourceEndpoint":"//xxx",
"sourceBucket":"bucket-xxx",
"sourceAccessKey":"xxx",
"sourceSecretKey":"xxx",
"sourceBucketType":"Prefix",
"migrateFolder":[],
"migrateFiles":[],
"migratePrefix":["ajy"]
}],
"destinationInfo":[{
"destinationType":"ZOS",
"destinationEndpoint":"//xxx",
"destinationBucket":"bucket-xxx",
"destinationAccessKey":"xxx",
"destinationSecretKey":"xxx"
}]
}
響應示例
{
"returnObj": {
"migrationID": "222_mig_cf0XXXXXXXXXXa0cb34fdf7a2d5705c5",
"result": "success"
},
"details": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
狀態碼
請參考
錯誤碼
請參考