首页 云存储网关 开发参考 API参考指南 API目录 极速同步组 DescribeExpressSyncShares - 查询极速同步组的共享信息或可加入的共享信息

DescribeExpressSyncShares - 查询极速同步组的共享信息或可加入的共享信息

更新时间: 2025-03-31 14:23:42

查询极速同步组对应的共享信息或可加入极速同步组的共享信息。包括极速同步组对应共享的网关名称、集群ID、共享名称等详情。

调试

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

授权信息

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

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

请求参数

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

同步组的 ID 列表。同步组 ID 之间以逗号进行分割。

sync-0002xetjdlxne2sd***,sync-0004agfrbke1l39p***
IsExternalboolean

是否查询已加入的共享。取值范围:

  • true:查询可加入该同步组的共享信息。

  • false:查询已在同步组的共享信息。

默认值:false。

true

返回参数

名称类型描述示例值
object
Messagestring

请求结果描述。

successful
RequestIdstring

请求 ID。

EA258616-36AD-4609-A0A6-2B17C28CBF88
Codestring

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

200
Sharesarray<object>

极速同步组共享信息。

Shareobject
MnsQueuestring

该共享在阿里云轻量消息队列(原 MNS)中对应的消息队列(Queue)名称。

sgw-express-sync-queue-gw-000245alq48e7ytgxq03***
ExpressSyncIdstring

极速同步 ID。

sb-0003c7qh5yuc1z6b8***
GatewayIdstring

网关 ID。

gw-000245alq48e7ytg***
ExpressSyncStatestring

极速同步组健康状态。可能值:

  • TopicAndQueueFailure:消息队列消息主题无法访问。

  • TopicFailure:消息主题无法访问。

  • MNSFullSyncInit:全量同步等待中。

  • MNSFullSyncing:全量同步进行中。

  • QueueFailure:消息队列无法访问。

  • MNSNotEnabled:极速同步未开启。

  • MNSHealthy::同步正常。

MNSHealthy
GatewayNamestring

网关名称。

file-升级***
StorageBundleIdstring

网关集群 ID。

sb-0003c7qh5yuc1z6b8***
SyncProgressinteger

共享全量同步进度。当共享已加入同步组的情况下, 该返回参数有效。可能值:

  • 0~100:共享全量同步进度,百分比。

  • -1:表示共享并未发生全量同步。

  • -2:表示共享所在网关版本不支持该功能。

100
GatewayRegionstring

网关所在地域。

cn-hangzhou
ShareNamestring

共享名称。

ji***
Successboolean

请求是否成功。

true

示例

正常返回示例

JSON格式

{
  "Message": "successful",
  "RequestId": "EA258616-36AD-4609-A0A6-2B17C28CBF88",
  "Code": "200",
  "Shares": {
    "Share": [
      {
        "MnsQueue": "sgw-express-sync-queue-gw-000245alq48e7ytgxq03***",
        "ExpressSyncId": "sb-0003c7qh5yuc1z6b8***",
        "GatewayId": "gw-000245alq48e7ytg***",
        "ExpressSyncState": "MNSHealthy",
        "GatewayName": "file-升级***",
        "StorageBundleId": "sb-0003c7qh5yuc1z6b8***",
        "SyncProgress": 100,
        "GatewayRegion": "cn-hangzhou",
        "ShareName": "ji***"
      }
    ]
  },
  "Success": true
}

错误码

HTTP status code错误码错误信息描述
400EmptyExpressSyncIdYou must specify a valid ID for the sync group.极速同步组ID不能为空。
400ExpressSyncNotExistThe specified sync group does not exist. You must specify a valid parameter.极速同步组不存在,请确认输入参数是否正确。
400GatewayNotExistThe specified gateway does not exist. You must specify a valid parameter.网关不存在,请确认输入参数是否正确。

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

变更历史

变更时间变更内容概要操作
暂无变更历史
上一篇: AddSharesToExpressSync - 添加共享到极速同步组中 下一篇: RemoveSharesFromExpressSync - 删除极速同步组对应的共享
阿里云首页 云存储网关 相关技术圈