对象存储迁移服务 OMS对象存储迁移服务 OMS

更新时间:2021/08/02 GMT+08:00
分享

创建迁移任务

功能介绍

创建迁移任务,创建成功后,任务会被自动启动,不需要额外调用启动任务命令。

接口约束

  • 单个租户在过去24小时内最多可创建1500个迁移任务。
  • 单个租户名下处于“等待中”状态的迁移任务达到1500个时不可再创建任务。

调试

您可以在API Explorer中调试该接口。

URI

POST /v2/{project_id}/tasks

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

最小长度:1

最大长度:1024

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

IAM鉴权Token。

最小长度:1

最大长度:16384

表3 请求Body参数

参数

是否必选

参数类型

描述

task_type

String

任务类型,默认为object。

list:对象列表迁移 url_list:URL列表迁移 object:文件/文件夹迁移,默认 prefix:对象前缀迁移

缺省值:object

枚举值:

  • list
  • url_list
  • object
  • prefix

src_node

SrcNodeReq object

源端信息。

dst_node

DstNodeReq object

目的端信息。

enable_kms

Boolean

是否开启KMS加密,默认不开启。

缺省值:false

description

String

任务描述,不能超过255个字符,且不能包含^<>&"'等特殊字符。

最小长度:0

最大长度:255

migrate_since

Long

以时间戳方式表示的迁移指定时间(单位:秒),表示仅迁移在指定时间之后修改的源端待迁移对象。默认不设置迁移指定时间。

最小值:0

最大值:9223372036854775807

缺省值:0

bandwidth_policy

Array of BandwidthPolicyDto objects

配置流量控制策略。数组中一个元素对应一个时段的最大带宽,最多允许5个时段,且时段不能重叠。

source_cdn

SourceCdnReq object

指定是否启用CDN迁移支持,若包含此字段则为支持,否则为不支持,启用CDN迁移支持后,迁移时将从CDN域名获取源端对象。

smn_config

SmnConfig object

SMN消息发送配置。

enable_restore

Boolean

是否自动解冻归档数据,默认否。

开启后,如果遇到归档类型数据,会自动解冻再进行迁移。

缺省值:false

enable_failed_object_recording

Boolean

是否记录失败对象,默认开启。

开启后,如果有迁移失败对象,会在目的端存储失败对象信息。

缺省值:true

表4 SrcNodeReq

参数

是否必选

参数类型

描述

cloud_type

String

源端云服务提供商,task_type为非url_list时,本参数为URLSource。

可选值有AWS、Azure、Aliyun、Tencent、HuaweiCloud、QingCloud、KingsoftCloud、Baidu、Qiniu、URLSource或者UCloud。默认值为Aliyun。

缺省值:Aliyun

region

String

源端桶所处的区域,task_type为非url_list时,本参数为必选。

最小长度:0

最大长度:100

ak

String

源端桶的AK(最大长度100个字符),task_type为非url_list时,本参数为必选。

最小长度:0

最大长度:100

sk

String

源端桶的SK(最大长度100个字符),task_type为非url_list时,本参数为必选。

最小长度:0

最大长度:100

security_token

String

源端桶的临时Token(最大长度16384个字符)

最小长度:0

最大长度:16384

app_id

String

当源端为腾讯云时,需要填写此参数。

最小长度:0

最大长度:255

bucket

String

源端桶的名称,task_type为非url_list时,本参数为必选。

最小长度:0

最大长度:1024

object_key

Array of strings

任务类型为对象迁移任务时,表示待迁移对象名称(以“/”结尾的字符串代表待迁移的文件夹,非“/”结尾的字符串代表待迁移的文件。); 任务类型为前缀迁移任务时,表示待迁移前缀。 整桶迁移时,此参数设置为[""]。

最小长度:0

最大长度:1024

list_file

ListFile object

列表文件配置,当task_type为list或url_list时,list_file为必选参数。

表5 ListFile

参数

是否必选

参数类型

描述

list_file_key

String

对象列表文件或URL列表文件对象名。

最小长度:1

最大长度:1024

obs_bucket

String

存放对象列表文件的OBS桶名。

请确保与目的端桶处于同一区域,否则将导致任务创建失败。

最小长度:0

最大长度:1024

表6 DstNodeReq

参数

是否必选

参数类型

描述

ak

String

目的端桶的AK(最大长度100个字符)。

最小长度:0

最大长度:100

sk

String

目的端桶的SK(最大长度100个字符)。

最小长度:0

最大长度:100

security_token

String

目的端的临时Token(最大长度16384个字符)。

最小长度:0

最大长度:16384

bucket

String

目的端桶的名称。

最小长度:0

最大长度:1024

save_prefix

String

目的端桶内路径前缀(拼接在对象key前面,组成新的key,拼接后不能超过1024个字符)。

最小长度:0

最大长度:1024

region

String

目的端桶所处的区域。

请与Endpoint对应的区域保持一致。

最小长度:0

最大长度:100

表7 BandwidthPolicyDto

参数

是否必选

参数类型

描述

end

String

流量控制结束时间(包含),格式为“hh:mm”。例如“12:03”表示12时03分。

max_bandwidth

Long

时段内允许的最大流量带宽,单位Byte/s,取值范围为>= 1048576Byte/s(相当于1MB/s)且<=209715200Byte/s(相当于200MB/s)。

最小值:1048576

最大值:209715200

start

String

流量控制开始时间(包含),格式为“hh:mm”。例如“12:03”表示12时03分。

表8 SourceCdnReq

参数

是否必选

参数类型

描述

authentication_key

String

CDN鉴权秘钥,如果CDN需要进行鉴权,则此选项为必选。

无需授权:无需配置此项。 Qiniu:无需配置此项。 Aliyun:根据authentication_type指定的鉴权方式配置此项。 KingsoftCloud:无需配置此项。

最小长度:0

最大长度:255

authentication_type

String

鉴权类型: NONE, QINIU_PRIVATE_AUTHENTICATION, ALIYUN_OSS_A, ALIYUN_OSS_B, ALIYUN_OSS_C, KSYUN_PRIVATE_AUTHENTICATION, AZURE_SAS_TOKEN

缺省值:NONE

枚举值:

  • NONE
  • QINIU_PRIVATE_AUTHENTICATION
  • ALIYUN_OSS_A
  • ALIYUN_OSS_B
  • ALIYUN_OSS_C
  • KSYUN_PRIVATE_AUTHENTICATION

domain

String

从指定域名获取对象。

最小长度:0

最大长度:1024

protocol

String

协议类型,支持http和https协议。

枚举值:

  • http
  • https
表9 SmnConfig

参数

是否必选

参数类型

描述

language

String

当前用户所使用的管理控制台的语言。

可以选择zh-cn或者en-us。

缺省值:en-us

枚举值:

  • zh-cn
  • en-us

topic_urn

String

迁移任务所绑定的SMN消息主题的urn号。

最小长度:0

最大长度:1024

trigger_conditions

Array of strings

SMN消息的触发条件,取决于迁移任务状态。

迁移任务状态的取值范围为SUCCESS或者FAILURE。

  • FAILURE表示任务失败后发送SMN消息。
  • SUCCESS表示任务成功后发送SMN消息。

响应参数

状态码: 201

表10 响应Body参数

参数

参数类型

描述

id

Long

任务ID。

最小值:0

最大值:999999999999999

task_name

String

任务名称。

最小长度:0

最大长度:2048

状态码: 400

表11 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

error_code

String

错误码。

请求示例

  • 创建对象列表迁移任务,使用CDN方式迁移,开启按时段限速,开启迁移结果通知。
    POST https://{endpoint}/v2/{project_id}/tasks
    
    {
      "task_type" : "list",
      "src_node" : {
        "cloud_type" : "HuaweiCloud",
        "region" : "cn-north-1",
        "bucket" : "src_bucket",
        "ak" : "src_ak",
        "sk" : "src_sk",
        "list_file" : {
          "obs_bucket" : "list_file_bucket",
          "list_file_key" : "object_list_file.txt"
        }
      },
      "dst_node" : {
        "region" : "cn-north-1",
        "ak" : "dst_ak",
        "sk" : "dst_sk",
        "bucket" : "dst_bucket"
      },
      "enable_kms" : false,
      "enable_failed_object_recording" : true,
      "description" : "xxx",
      "migrate_since" : 123456789,
      "bandwidth_policy" : [ {
        "start" : "00:00",
        "end" : "23:59",
        "max_bandwidth" : 50000000
      } ],
      "source_cdn" : {
        "protocol" : "https",
        "domain" : "xxx.xxx.xxx",
        "authentication_type" : "ALIYUN_OSS_A",
        "authentication_key" : "xxx"
      },
      "smn_config" : {
        "topic_urn" : "urn:smn:region:4cf2090802d94440b4cdd72ef26857b2:OMS",
        "trigger_conditions" : [ "SUCCESS", "FAILURE" ],
        "language" : "en-us"
      }
    }
  • 创建对象迁移任务,使用CDN方式迁移,开启按时段限速,开启迁移结果通知。
    POST https://{endpoint}/v2/{project_id}/tasks
    
    {
      "task_type" : "object",
      "src_node" : {
        "cloud_type" : "HuaweiCloud",
        "region" : "cn-north-1",
        "bucket" : "src_bucket",
        "ak" : "src_ak",
        "sk" : "src_sk",
        "object_key" : [ "file1.xxx", "file2.xxx", "path1/" ]
      },
      "dst_node" : {
        "region" : "cn-north-1",
        "ak" : "dst_ak",
        "sk" : "dst_sk",
        "bucket" : "dst_bucket"
      },
      "enable_kms" : false,
      "enable_failed_object_recording" : true,
      "description" : "xxx",
      "migrate_since" : 123456789,
      "bandwidth_policy" : [ {
        "start" : "00:00",
        "end" : "23:59",
        "max_bandwidth" : 50000000
      } ],
      "source_cdn" : {
        "protocol" : "https",
        "domain" : "xxx.xxx.xxx",
        "authentication_type" : "ALIYUN_OSS_A",
        "authentication_key" : "xxx"
      },
      "smn_config" : {
        "topic_urn" : "urn:smn:region:4cf2090802d94440b4cdd72ef26857b2:OMS",
        "trigger_conditions" : [ "SUCCESS", "FAILURE" ],
        "language" : "en-us"
      }
    }
  • 创建URL列表迁移任务。
    POST https://{endpoint}/v2/{project_id}/tasks
    
    {
      "task_type" : "url_list",
      "src_node" : {
        "cloud_type" : "URLSource",
        "list_file" : {
          "obs_bucket" : "list_file_bucket",
          "list_file_key" : "object_list_file.txt"
        }
      },
      "dst_node" : {
        "region" : "cn-north-1",
        "ak" : "dst_ak",
        "sk" : "dst_sk",
        "bucket" : "dst_bucket"
      },
      "enable_kms" : false,
      "enable_failed_object_recording" : true,
      "description" : "xxx"
    }
  • 创建前缀迁移任务。
    POST https://{endpoint}/v2/{project_id}/tasks
    
    {
      "task_type" : "prefix",
      "src_node" : {
        "cloud_type" : "HuaweiCloud",
        "region" : "cn-north-1",
        "bucket" : "src_bucket",
        "ak" : "src_ak",
        "sk" : "src_sk",
        "object_key" : [ "abc", "123", "prefix3", "path/prefix4" ]
      },
      "dst_node" : {
        "region" : "cn-north-1",
        "ak" : "dst_ak",
        "sk" : "dst_sk",
        "bucket" : "dst_bucket"
      },
      "enable_kms" : false,
      "enable_failed_object_recording" : true,
      "description" : "xxx"
    }

响应示例

状态码: 201

Created

{
  "id" : 200429548242937,
  "task_name" : "task_name"
}

状态码

状态码

描述

201

Created

400

Bad Request

错误码

请参见错误码

分享:

    相关文档

    相关产品