调用DescribeExpressSyncs可以查询指定的极速同步组。包括极速同步组名称、极速同步组ID、Bucket名称等详情。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeExpressSyncs |
系统规定参数。取值:DescribeExpressSyncs。 |
BucketName | String | 否 | sgw*** |
Bucket 名称。不传默认查询该用户下所有的极速同步组。 |
BucketPrefix | String | 否 | test*** |
Bucket 子目录。不传查询该Bucket的极速同步组,传空字符串默认查询该Bucket根目录的极速同步组。 说明 不支持Bucket名称为空,只查询Bucket子目录的场景。
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Code | String | 200 |
状态码。状态码为200表示请求成功。 |
ExpressSyncs | Array |
极速同步组信息。 |
|
ExpressSync | |||
BucketName | String | sgw-mns*** |
极速同步组名称。 |
BucketPrefix | String | test*** |
Bucket 子目录。 |
BucketRegion | String | cn-hangzhou |
OSS 区域。 |
Description | String | 测试使用 |
极速同步组描述。 |
ExpressSyncId | String | sync-0002xetjdlxne2sdm*** |
极速同步组ID。 |
MnsTopic | String | sgw-express-sync-0002xetjdlxne2sdm*** |
该同步组在阿里云消息服务 MNS 中对应的消息主题(Topic)名称。 |
Name | String | wptest*** |
极速同步组名称。 |
Message | String | successful |
请求结果描述。 |
RequestId | String | 50DE1383-D4A1-433C-98A6-459C1830A888 |
请求ID。 |
Success | Boolean | true |
请求是否成功。 |
示例
请求示例
http(s)://[Endpoint]/?Action=DescribeExpressSyncs
&<公共请求参数>
正常返回示例
XML
格式
<DescribeExpressSyncsResponse>
<ExpressSyncs>
<ExpressSync>
<Description></Description>
<BucketName>sgw-mns***</BucketName>
<MnsTopic>sgw-express-sync-0002xetjdlxne2sdm***</MnsTopic>
<BucketRegion>cn-hangzhou</BucketRegion>
<BucketPrefix>test1</BucketPrefix>
<ExpressSyncId>sync-0002xetjdlxne2sdm***</ExpressSyncId>
<Name>wptest***</Name>
</ExpressSync>
<ExpressSync>
<BucketName>test-kms***</BucketName>
<MnsTopic>sgw-express-sync-0004agfrbke1l39pb***</MnsTopic>
<BucketRegion>cn-hangzhou</BucketRegion>
<BucketPrefix>kms-1118</BucketPrefix>
<ExpressSyncId>sync-0004agfrbke1l39pb***</ExpressSyncId>
<Name>js18-1***</Name>
</ExpressSync>
<ExpressSync>
<BucketName>file***</BucketName>
<MnsTopic>sgw-express-sync-topic-sync-000jf2sbjhf9jatey***</MnsTopic>
<BucketRegion>cn-hangzhou</BucketRegion>
<BucketPrefix></BucketPrefix>
<ExpressSyncId>sync-000jf2sbjhf9jatey***</ExpressSyncId>
<Name>f6***</Name>
</ExpressSync>
</ExpressSyncs>
<Message>successful</Message>
<RequestId>50DE1383-D4A1-433C-98A6-459C1830A888</RequestId>
<Code>200</Code>
<Success>true</Success>
</DescribeExpressSyncsResponse>
JSON
格式
{
"ExpressSyncs":{
"ExpressSync":[
{
"Description":"",
"BucketName":"sgw-mns***",
"MnsTopic":"sgw-express-sync-0002xetjdlxne2sdm***",
"BucketRegion":"cn-hangzhou",
"BucketPrefix":"test1",
"ExpressSyncId":"sync-0002xetjdlxne2sdm***",
"Name":"wptest***"
},
{
"BucketName":"test-kms***",
"MnsTopic":"sgw-express-sync-0004agfrbke1l39pb***",
"BucketRegion":"cn-hangzhou",
"BucketPrefix":"kms-1118",
"ExpressSyncId":"sync-0004agfrbke1l39pb***",
"Name":"js18-1***"
},
{
"BucketName":"file***",
"MnsTopic":"sgw-express-sync-topic-sync-000jf2sbjhf9jatey***",
"BucketRegion":"cn-hangzhou",
"BucketPrefix":"",
"ExpressSyncId":"sync-000jf2sbjhf9jatey***",
"Name":"f6***"
}
]
},
"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. | 非法请求,请检查请求参数。 |
访问错误中心查看更多错误码。