All Products
Search
Document Center

ENS:ListBuckets

Last Updated:Mar 12, 2024

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.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
PrefixstringNo

Specifies the prefix that returned bucket names must contain. If this parameter is not specified, prefix information will not be used as a filter.

image
PageNumberstringNo

The number of the page. Pages start from page 1.

1
PageSizestringNo

The maximum number of returned buckets. If this parameter is not specified, the default value is 10. The value cannot be greater than 100.

5

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The ID of the request.

435769C7-AA6F-4DC5-B3DB-A3DC0DE7E853
BucketInfosobject []

The list of bucket information.

BucketAclstring

The access control list (ACL) of the bucket.

private
BucketNamestring

The name of the bucket.

test
Commentstring

The remarks.

numb
CreateTimestring

The time when the bucket was created. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

2022-10-12T05:45:00Z
LogicalBucketTypestring

Single-node storage. Set the value to sink.

sink
ModifyTimestring

The time when the bucket was modified. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

2022-10-12T06:45:00Z
EnsRegionIdstring

The ID of the region where the node is located.

cn-dalian-unicom
TotalCountlong

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 codeError codeError message
400MissingParameterMissingParameter
400NoPermissionPermission denied.
400InvalidParameter.%sThe specified field %s invalid. Please check it again.
403AccessDeniedauth is not valid
404NoSuchBucketThe specified bucket does not exist

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