DescribeExpressSyncs - 查询极速同步组

查询极速同步组,包括极速同步组名称、极速同步组ID、Bucket名称等详情。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
hcs-sgw:DescribeExpressSyncsnone
*全部资源
*

请求参数

名称类型必填描述示例值
BucketNamestring

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

sgw****
BucketPrefixstring

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

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

返回参数

名称类型描述示例值
object
ExpressSyncsarray<object>

极速同步组信息。

ExpressSyncobject
ExpressSyncIdstring

极速同步组 ID。

sync-0002xetjdlxne2sd****
Descriptionstring

极速同步组描述。

测试使用
BucketNamestring

Bucket 名称。

sgw-mns****
Namestring

极速同步组名称。

wptest****
BucketPrefixstring

Bucket 子目录。

test****
MnsTopicstring

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

sgw-express-sync-0002xetjdlxne2sd****
BucketRegionstring

OSS 地域。

cn-hangzhou
Messagestring

请求结果描述。

successful
RequestIdstring

请求 ID。

50DE1383-D4A1-433C-98A6-459C1830A888
Codestring

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

200
Successboolean

请求结果。可能值:

  • true:是。
  • false:否。
true

示例

正常返回示例

JSON格式

{
  "ExpressSyncs": {
    "ExpressSync": [
      {
        "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
}

错误码

HTTP status code错误码错误信息描述
400BadRequestInvalid request. You must specify valid parameters in the request. 非法请求,请检查请求参数。

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

变更历史

变更时间变更内容概要操作
暂无变更历史