DescribeStorageBundles - Cloud Storage Gateway - Alibaba Cloud Documentation Center

Queries information about storage bundles, including their names, descriptions, and creation time.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
BackendBucketRegionId	string	Yes	The region where the gateway cluster resides. You can call the DescribeRegions operation to obtain a valid region ID.	cn-hangzhou
PageNumber	integer	No	The page number of the gateway cluster list. Start value: 1. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page for a paged query. Maximum value: 50. Default value: 10.	10

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	integer	The total number of gateway clusters.	20
RequestId	string	The request ID.	1EB4639B-0812-4F2D-AB78-194E67645E357
Message	string	The description of the request result.	successful
PageSize	integer	The number of entries returned on each page.	10
PageNumber	integer	The page number of the gateway cluster list.	1
Code	string	The status code. A status code of 200 indicates that the request is successful.	200
Success	boolean	Indicates whether the request is successful.	true
StorageBundles	object
StorageBundle	array<object>	The information about the gateway clusters.
	object
Description	string	The description of the gateway cluster.
BackendBucketRegionId	string	The region where the gateway cluster resides.	cn-hangzhou
StorageBundleId	string	The ID of the gateway cluster.	sb-000ibk4xrlr03qrjr***
Name	string	The name of the gateway cluster.	zy-test***
CreatedTime	integer	The time when the gateway cluster was created. The value is a UNIX timestamp. Unit: seconds.	1565750633

Examples

Success response

JSON format

{
  "TotalCount": 20,
  "RequestId": "1EB4639B-0812-4F2D-AB78-194E67645E357",
  "Message": "successful",
  "PageSize": 10,
  "PageNumber": 1,
  "Code": "200",
  "Success": true,
  "StorageBundles": {
    "StorageBundle": [
      {
        "Description": "",
        "BackendBucketRegionId": "cn-hangzhou",
        "StorageBundleId": "sb-000ibk4xrlr03qrjr***",
        "Name": "zy-test***",
        "CreatedTime": 1565750633
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	BadPageSize	The specified number of pages is invalid. The number ranges from 1 to 50.	The specified number of pages is invalid. The number ranges from 1 to 50.
400	BadPageNumber	The specified page number is invalid. The page number must be greater than 0.	The specified page number is invalid. The page number must be greater than 0.
400	InvalidRegionId	The specified RegionId does not exist. You must specify a valid RegionId.	The specified RegionId does not exist. You must specify a valid RegionId.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.