DescribeExpressSyncShares - Cloud Storage Gateway - Alibaba Cloud Documentation Center

Queries for shares that are associated with an express synchronization group or can be added to the group. The returned information includes details such as the gateway name, cluster ID, and share name.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that support authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

hcs-sgw:DescribeExpressSyncShares

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ExpressSyncIds	string	Yes	A list of express synchronization group IDs. The IDs are separated by commas.	sync-0002xetjdlxne2sd*,sync-0004agfrbke1l39p*
IsExternal	boolean	No	Specifies whether to query the shares that have been added to the express synchronization group. Valid values: true: queries the information about shares that can be added to the express synchronization group. false: queries the information about shares that are in the express synchronization group. Default value: false.	true

Response parameters

Parameter	Type	Description	Example
	object
Message	string	The description of the request result.	successful
RequestId	string	The request ID.	EA258616-36AD-4609-A0A6-2B17C28CBF88
Code	string	The status code. A status code of 200 indicates that the request was successful.	200
Shares	object
Share	array<object>	The information about the shares in the express synchronization group.
	object
MnsQueue	string	The name of the message queue (Queue) that corresponds to the share in Alibaba Cloud Simple Message Queue (formerly MNS).	sgw-express-sync-queue-gw-000245alq48e7ytgxq03***
ExpressSyncId	string	The express synchronization ID.	sb-0003c7qh5yuc1z6b8***
GatewayId	string	The gateway ID.	gw-000245alq48e7ytg***
ExpressSyncState	string	The health status of the express synchronization group. Possible values: TopicAndQueueFailure: The message topic and message queue are inaccessible. TopicFailure: The message topic is inaccessible. MNSFullSyncInit: A full synchronization is pending. MNSFullSyncing: A full synchronization is in progress. QueueFailure: The message queue is inaccessible. MNSNotEnabled: Express synchronization is disabled. MNSHealthy: The synchronization is normal.	MNSHealthy
GatewayName	string	The gateway name.
StorageBundleId	string	The gateway cluster ID.	sb-0003c7qh5yuc1z6b8***
SyncProgress	integer	The progress of the full synchronization of the share. This parameter is valid only when the share is added to an express synchronization group. Possible values: 0 to 100: the progress of the full synchronization of the share in percentage. -1: A full synchronization is not performed for the share. -2: The gateway version of the share does not support this feature.	100
GatewayRegion	string	The region where the gateway is located.	cn-hangzhou
ShareName	string	The share name.	ji***
Success	boolean	Indicates whether the request was successful.	true

Examples

Success response

JSON format

{
  "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": "",
        "StorageBundleId": "sb-0003c7qh5yuc1z6b8***",
        "SyncProgress": 100,
        "GatewayRegion": "cn-hangzhou",
        "ShareName": "ji***"
      }
    ]
  },
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	EmptyExpressSyncId	You must specify a valid ID for the sync group.	You must specify a valid ID for the sync group.
400	ExpressSyncNotExist	The specified sync group does not exist. You must specify a valid parameter.	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.	The specified gateway does not exist. You must specify a valid parameter.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.