Use the ListBuckets API to query all buckets - ENS

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 supports 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

ens:ListBuckets

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Prefix	string	No	The prefix that returned bucket names must contain. If this parameter is not specified, prefix information will not be used as a filter.	image
PageNumber	string	No	The page number. Pages start from page 1.	1
PageSize	string	No	The maximum number of returned buckets. You can leave this parameter empty. The default value is 10. The value cannot be greater than 100.	5

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	435769C7-AA6F-4DC5-B3DB-A3DC0DE7E853
BucketInfos	array<object>	The list of bucket information.
	object
BucketAcl	string	The access control list (ACL) of the bucket. public-read-write public-read private (default)	private
BucketName	string	The name of the bucket.	test
Comment	string	The remarks.	numb
CreateTime	string	The time when the bucket was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2022-10-12T05:45:00Z
LogicalBucketType	string	The type of the single-node storage. Set the value to sink.	sink
ModifyTime	string	The time when the bucket was modified. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2022-10-12T06:45:00Z
EnsRegionId	string	The ID of the region where the node is located.	cn-dalian-unicom
TotalCount	integer	The total number of buckets that match the conditions.	1

Examples

Success response

JSON format

{
  "RequestId": "435769C7-AA6F-4DC5-B3DB-A3DC0DE7E853",
  "BucketInfos": [
    {
      "BucketAcl": "private",
      "BucketName": "test",
      "Comment": "numb",
      "CreateTime": "2022-10-12T05:45:00Z",
      "LogicalBucketType": "sink",
      "ModifyTime": "2022-10-12T06:45:00Z",
      "EnsRegionId": "cn-dalian-unicom"
    }
  ],
  "TotalCount": 1
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParameter	MissingParameter
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.
403	AccessDenied	auth is not valid
403	UserDisable	The user has been disabled due to arrears.	The user has been disabled due to arrears.
404	NoSuchBucket	The specified bucket does not exist

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.