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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeExpressSyncShares

系统规定参数。取值：DescribeExpressSyncShares。
ExpressSyncIds String 是 sync-0002xetjdlxne2sd***,sync-0004agfrbke1l39p***

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

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

  • true：查询可加入该同步组的共享信息。
  • false：查询已在同步组的共享信息。

默认值：false。

返回数据

名称 类型 示例值 描述
RequestId String EA258616-36AD-4609-A0A6-2B17C28CBF88

请求ID。
Success Boolean true

请求是否成功。
Code String 200

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

请求结果描述。
Shares Array

极速同步组共享信息。
GatewayId String gw-000245alq48e7ytg***

网关ID。
StorageBundleId String sb-0003c7qh5yuc1z6b8***

网关集群ID。
GatewayName String file-升级***

网关名称。
GatewayRegion String cn-hangzhou

网关所在地域。
ShareName String ji***

共享名称。
ExpressSyncState String MNSHealthy

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

  • TopicAndQueueFailure：消息队列消息主题无法访问。
  • TopicFailure：消息主题无法访问。
  • MNSFullSyncInit：全量同步等待中。
  • MNSFullSyncing：全量同步进行中。
  • QueueFailure：消息队列无法访问。
  • MNSNotEnabled：极速同步未开启。
  • MNSHealthy:：同步正常。
ExpressSyncId String sb-0003c7qh5yuc1z6b8***

极速同步ID。
MnsQueue String sgw-express-sync-queue-gw-000245alq48e7ytgxq03***

该共享在阿里云消息服务 MNS 中对应的消息队列（Queue）名称。
SyncProgress Integer 100

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

  • 0~100：共享全量同步进度，百分比。
  • -1：表示共享并未发生全量同步。
  • -2：表示共享所在网关版本不支持该功能。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeExpressSyncShares
&ExpressSyncIds=sync-0002xetjdlxne2sd***,sync-0004agfrbke1l39p***
&<公共请求参数>

正常返回示例

XML 格式 

<DescribeExpressSyncSharesResponse>
      <Message>successful</Message>
      <RequestId>EA258616-36AD-4609-A0A6-2B17C28CBF88</RequestId>
      <Shares>
            <Share>
                  <ExpressSyncState>MNSHealthy</ExpressSyncState>
                  <ShareName>ji***</ShareName>
                  <GatewayRegion>cn-hangzhou</GatewayRegion>
                  <StorageBundleId>sb-0003c7qh5yuc1z6b8***</StorageBundleId>
                  <GatewayName>file-升级***</GatewayName>
                  <GatewayId>gw-000245alq48e7ytg***</GatewayId>
                  <ExpressSyncId>sync-000ip92hqkvu0gbxi***</ExpressSyncId>
                  <SyncProgress>100</SyncProgress>
                  <MnsQueue>sgw-express-sync-queue-gw-000245alq48e7ytgxq03***</MnsQueue>
            </Share>
            <Share>
                  <ExpressSyncState>MNSHealthy</ExpressSyncState>
                  <ShareName>cifs12***</ShareName>
                  <GatewayRegion>cn-hangzhou</GatewayRegion>
                  <StorageBundleId>sb-000gxdrndxrm50gtl***</StorageBundleId>
                  <GatewayName>file122***</GatewayName>
                  <GatewayId>gw-000hqr50529yvycly***</GatewayId>
                  <ExpressSyncId>sync-000jf2sbjhfatey3***</ExpressSyncId>
                  <SyncProgress>100</SyncProgress>
                  <MnsQueue>sgw-express-sync-queue-gw-000hqr5052cly5xa***</MnsQueue>
            </Share>
      </Shares>
      <Code>200</Code>
      <Success>true</Success>
</DescribeExpressSyncSharesResponse>

JSON 格式 

{
    "Message":"successful",
    "RequestId":"EA258616-36AD-4609-A0A6-2B17C28CBF88",
    "Shares":{
        "Share":[
            {
                "ExpressSyncState":"MNSHealthy",
                "ShareName":"ji***",
                "GatewayRegion":"cn-hangzhou",
                "StorageBundleId":"sb-0003c7qh5yuc1z6b8***",
                "GatewayName":"file-升级***",
                "GatewayId":"gw-000245alq48e7ytg***",
                "ExpressSyncId":"sync-000ip92hqkvu0gbxi***",
                "SyncProgress":"100",
                "MnsQueue":"sgw-express-sync-queue-gw-000245alq48e7ytgxq03***"
            },
            {
                "ExpressSyncState":"MNSHealthy",
                "ShareName":"cifs12***",
                "GatewayRegion":"cn-hangzhou",
                "StorageBundleId":"sb-000gxdrndxrm50gtl***",
                "GatewayName":"file122***",
                "GatewayId":"gw-000hqr50529yvycly***",
                "ExpressSyncId":"sync-000jf2sbjhfatey3***",
                "SyncProgress":"100",
                "MnsQueue":"sgw-express-sync-queue-gw-000hqr5052cly5xa***"
            }
        ]
    },
    "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 GatewayNotExist The specified gateway does not exist. You must specify a valid parameter. 网关不存在，请确认输入参数是否正确。

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