ListBuckets - ENS - Alibaba Cloud Documentation Center

Queries all buckets of a user.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ens:ListBuckets	list	All Resources *	none	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 parameters

Parameter	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	long	The total number of buckets that match the conditions.	1

Examples

Sample success responses

JSONformat

{
  "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
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
404	NoSuchBucket	The specified bucket does not exist

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history