DescribeExpressSyncs API Reference - Cloud Storage Gateway

Queries the details of express synchronization groups, including their names, IDs, and bucket names.

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:DescribeExpressSyncs

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
BucketName	string	No	The name of the bucket. If you do not specify this parameter, all express synchronization groups that belong to the current user are queried.	sgw***
BucketPrefix	string	No	The subdirectory of the bucket. If you do not specify this parameter, the express synchronization groups of the bucket are queried. If you specify an empty string, the express synchronization groups in the root directory of the bucket are queried by default. Note You cannot leave the bucket name empty and query only the bucket subdirectory.	test***

Response parameters

Parameter	Type	Description	Example
	object
ExpressSyncs	object
ExpressSync	array<object>	The information about the express synchronization groups.
	object
ExpressSyncId	string	The ID of the express synchronization group.	sync-0002xetjdlxne2sdm***
Description	string	The description of the express synchronization group.
BucketName	string	The name of the bucket.	sgw-mns***
Name	string	The name of the express synchronization group.	wptest***
BucketPrefix	string	The subdirectory of the bucket.	test***
MnsTopic	string	The name of the message topic in Simple Message Queue (formerly MNS) that corresponds to the synchronization group.	sgw-express-sync-0002xetjdlxne2sdm***
BucketRegion	string	The OSS region.	cn-hangzhou
Message	string	The description of the request result.	successful
RequestId	string	The request ID.	50DE1383-D4A1-433C-98A6-459C1830A888
Code	string	The status code. A status code of 200 indicates that the request is successful.	200
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Success response

JSON format

{
  "ExpressSyncs": {
    "ExpressSync": [
      {
        "ExpressSyncId": "sync-0002xetjdlxne2sdm***",
        "Description": "",
        "BucketName": "sgw-mns***",
        "Name": "wptest***",
        "BucketPrefix": "test***",
        "MnsTopic": "sgw-express-sync-0002xetjdlxne2sdm***",
        "BucketRegion": "cn-hangzhou"
      }
    ]
  },
  "Message": "successful",
  "RequestId": "50DE1383-D4A1-433C-98A6-459C1830A888",
  "Code": "200",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	BadRequest	Invalid request. You must specify valid parameters in the request.	Invalid request. You must specify valid parameters in the request.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.