文档

AddSharesToExpressSync

更新时间:

调用AddSharesToExpressSync可以添加指定的共享到极速同步组中。

调用该接口时,您需要注意:

  • 请确认您已创建极速同步组。如果还未创建,您可以通过CreateExpressSync创建极速同步组,且同步组的Bucket必须与共享的Bucket相同。
  • 如果您传入的共享名称为空,请求将被忽略。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称

类型

是否必选

示例值

描述

Action String AddSharesToExpressSync

系统规定参数。取值:AddSharesToExpressSync

ExpressSyncId String sync-0001xv7je357xn8tr***

极速同步组ID。

GatewayShares String {"gw-000gwgp0j3jp8cb3t***":"share1,share2","gw-0001b2otnkdzte62j***":"weekly"}

网关共享名称。可以添加多个共享,JSON格式为:{"网关ID1":"共享1,共享2","网关ID2":"共享1,共享2"}

返回数据

名称

类型

示例值

描述

TaskId String t-0001xv7je357xr6ql***

任务ID。

RequestId String 1EDBC004-6B1C-4511-ACF5-0B4875BA3887

请求ID。

Message String successful

请求结果描述。

MnsTopic String sgw-express-sync-topic-sync-0009e51kabuou08***

极速同步组使用的消息服务(MNS)主题。

MnsQueues String sgw-express-sync-queue-gw-0009e51kabuoty9***-341604

极速同步组使用的消息服务(MNS)队列。

MnsFullSyncDelay Long 719

首次全量同步延迟时间,单位为秒。

MnsPublicEndpoint String http://123.mns.cn-hangzhou.aliyuncs.com/

极速同步组使用的消息服务(MNS)公网访问Endpoint。

MnsInnerEndpoint String http://123.mns.cn-hangzhou-internal.aliyuncs.com/

极速同步组使用的消息服务(MNS)内网访问Endpoint。

Code String 200

状态码。状态码为200表示请求成功。

Success Boolean true

请求是否成功。

示例

请求示例

http(s)://[Endpoint]/?Action=AddSharesToExpressSync
&ExpressSyncId=sync-0001xv7je357xn8tr***
&GatewayShares={"gw-000gwgp0j3jp8cb3t***":"share1,share2","gw-0001b2otnkdzte62j***":"weekly"}
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<AddSharesToExpressSyncResponse>
    <TaskId>t-0001xv7je357xr6ql***</TaskId>
    <RequestId>1EDBC004-6B1C-4511-ACF5-0B4875BA3887</RequestId>
    <Message>successful</Message>
    <MnsTopic>sgw-express-sync-topic-sync-0009e51kabuou08***</MnsTopic>
    <MnsQueues>sgw-express-sync-queue-gw-0009e51kabuoty9***-341604</MnsQueues>
    <MnsFullSyncDelay>719</MnsFullSyncDelay>
    <MnsPublicEndpoint>http://123.mns.cn-hangzhou.aliyuncs.com/</MnsPublicEndpoint>
    <MnsInnerEndpoint>http://123.mns.cn-hangzhou-internal.aliyuncs.com/</MnsInnerEndpoint>
    <Code>200</Code>
    <Success>true</Success>
</AddSharesToExpressSyncResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TaskId" : "t-0001xv7je357xr6ql***",
  "RequestId" : "1EDBC004-6B1C-4511-ACF5-0B4875BA3887",
  "Message" : "successful",
  "MnsTopic" : "sgw-express-sync-topic-sync-0009e51kabuou08***",
  "MnsQueues" : "sgw-express-sync-queue-gw-0009e51kabuoty9***-341604",
  "MnsFullSyncDelay" : 719,
  "MnsPublicEndpoint" : "http://123.mns.cn-hangzhou.aliyuncs.com/",
  "MnsInnerEndpoint" : "http://123.mns.cn-hangzhou-internal.aliyuncs.com/",
  "Code" : "200",
  "Success" : true
}

错误码

HttpCode

错误码

错误信息

描述

400 EmptyExpressSyncId You must specify a valid ID for the sync group. 极速同步组ID不能为空。
400 ExpressSyncNotExist The specified sync group does not exist. You must specify a valid parameter. 极速同步组不存在,请确认输入参数是否正确。
400 ExpressSyncInOperation The sync group is busy. Try again later. 极速同步组正在进行操作中,请稍后再试。

访问错误中心查看更多错误码。

  • 本页导读 (1)