文档首页/ 对象存储迁移服务 OMS/ API参考/ API v2（推荐）/ 同步任务/ 创建同步事件
更新时间：2024-09-10 GMT+08:00
在线调试
CLI示例
查看PDF
分享

创建同步事件

功能介绍

源端有对象需要进行同步时，调用该接口创建一个同步事件，系统将根据同步事件中包含的对象名称进行同步(目前只支持华北-北京四、华东-上海一地区)。

调用方法

请参见如何调用API。

URI

POST /v2/{project_id}/sync-tasks/{sync_task_id}/events

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

最小长度：1

最大长度：1024

sync_task_id

是

String

同步任务ID

最小长度：1

最大长度：1024

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

API认证鉴权的Token认证方式。推荐使用Authorization签名认证方式，具体请参考API认证鉴权

最小长度：1

最大长度：16384
表3 请求Body参数

参数

是否必选

参数类型

描述

object_keys

是

Array of strings

待同步对象的列表,其中待同步对象最大数量为10,列表中object_key为URL编码处理后的结果

最小长度：1

最大长度：16384

数组长度：1 - 100

响应参数

状态码： 400

表4 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

error_code

String

错误码。

状态码： 404

表5 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

error_code

String

错误码。

状态码： 503

表6 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

error_code

String

错误码。

请求示例

  • 对子任务31e9b7e6-6ffb-452f-9842-6ce354d99d75创建同步事件，对 [ "test%2F001.txt", "test%2F002.txt" ] 进行同步

    /v2/f697f813-554a-4f05-bac8-82a183b20878/sync-tasks/31e9b7e6-6ffb-452f-9842-6ce354d99d75/events

{
  "object_keys" : [ "test%2F001.txt", "test%2F002.txt" ]
}

  • 对子任务31e9b7e6-6ffb-452f-9842-6ce354d99d75创建同步事件，对 [ "test%2B001.txt"] 进行同步

    /v2/f697f813-554a-4f05-bac8-82a183b20878/sync-tasks/31e9b7e6-6ffb-452f-9842-6ce354d99d75/events

{
  "object_keys" : [ "test%2B001.txt" ]
}

  • 对子任务31e9b7e6-6ffb-452f-9842-6ce354d99d75创建同步事件，对 [ "test+001.txt" ] 进行同步

    /v2/f697f813-554a-4f05-bac8-82a183b20878/sync-tasks/31e9b7e6-6ffb-452f-9842-6ce354d99d75/events

{
  "object_keys" : [ "test+001.txt" ]
}

响应示例

无

状态码

状态码

描述

200

OK 创建同步事件成功

400

Bad Request 请求参数错误

404

Not Found 同步任务不存在

503

Service UnAvailable 服务暂不可用，请稍后再试

错误码

请参见错误码。

父主题： 同步任务

相关文档