DescribeExpressSyncs

调用DescribeExpressSyncs可以查询指定的极速同步组。包括极速同步组名称、极速同步组ID、Bucket名称等详情。

请求参数

名称

类型

是否必选

示例值

描述

Action String DescribeExpressSyncs

系统规定参数。取值:DescribeExpressSyncs

BucketName String sgw****

Bucket 名称。未传递参数时,默认查询该用户下的所有极速同步组。

BucketPrefix String test****

Bucket 子目录,未传递查询该Bucket的极速同步组时,传入空字符串将默认查询该Bucket根目录的极速同步组。

说明 不支持Bucket名称为空,只查询Bucket子目录的场景。

返回数据

名称

类型

示例值

描述

ExpressSyncs Array of ExpressSync

极速同步组信息。

ExpressSync
ExpressSyncId String sync-0002xetjdlxne2sd****

极速同步组ID。

Description String 测试使用

极速同步组描述。

BucketName String sgw-mns****

Bucket 名称。

Name String wptest****

极速同步组名称。

BucketPrefix String test****

Bucket 子目录。

MnsTopic String sgw-express-sync-0002xetjdlxne2sd****

该同步组在阿里云轻量消息队列(原 MNS)中对应的消息主题(Topic)名称。

BucketRegion String cn-hangzhou

OSS 地域。

Message String successful

请求结果描述。

RequestId String 50DE1383-D4A1-433C-98A6-459C1830A888

请求ID。

Code String 200

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

Success Boolean true

请求结果。可能值:

  • true:是。
  • false:否。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeExpressSyncs
&BucketName=sgw****
&BucketPrefix=test****
&公共请求参数

正常返回示例

XML格式

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

<DescribeExpressSyncsResponse>
    <ExpressSyncs>
        <ExpressSyncId>sync-0002xetjdlxne2sd****</ExpressSyncId>
        <Description>测试使用</Description>
        <BucketName>sgw-mns****</BucketName>
        <Name>wptest****</Name>
        <BucketPrefix>test****</BucketPrefix>
        <MnsTopic>sgw-express-sync-0002xetjdlxne2sd****</MnsTopic>
        <BucketRegion>cn-hangzhou</BucketRegion>
    </ExpressSyncs>
    <Message>successful</Message>
    <RequestId>50DE1383-D4A1-433C-98A6-459C1830A888</RequestId>
    <Code>200</Code>
    <Success>true</Success>
</DescribeExpressSyncsResponse>

JSON格式

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

{
  "ExpressSyncs" : [ {
    "ExpressSyncId" : "sync-0002xetjdlxne2sd****",
    "Description" : "测试使用",
    "BucketName" : "sgw-mns****",
    "Name" : "wptest****",
    "BucketPrefix" : "test****",
    "MnsTopic" : "sgw-express-sync-0002xetjdlxne2sd****",
    "BucketRegion" : "cn-hangzhou"
  } ],
  "Message" : "successful",
  "RequestId" : "50DE1383-D4A1-433C-98A6-459C1830A888",
  "Code" : "200",
  "Success" : true
}

错误码

HttpCode

错误码

错误信息

描述

400 BadRequest Invalid request. You must specify valid parameters in the request.  非法请求,请检查请求参数。

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