接口功能介绍
创建对象存储迁移任务
接口约束
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或域名,以https://或http://开头。如需使用非默认端口,请输入端口号 | http://xxx:8888或https://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或域名,以https://或http://开头。如需使用非默认端口,请输入端口号 | https://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":"http://xxx",
"sourceBucket":"bucket-xxx",
"sourceAccessKey":"xxx",
"sourceSecretKey":"xxx",
"sourceBucketType":"Prefix",
"migrateFolder":[],
"migrateFiles":[],
"migratePrefix":["ajy"]
}],
"destinationInfo":[{
"destinationType":"ZOS",
"destinationEndpoint":"http://xxx",
"destinationBucket":"bucket-xxx",
"destinationAccessKey":"xxx",
"destinationSecretKey":"xxx"
}]
}
响应示例
{
"returnObj": {
"migrationID": "222_mig_cf0XXXXXXXXXXa0cb34fdf7a2d5705c5",
"result": "success"
},
"details": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码