Help Center/ Cloud Container Engine/ API Reference/ Out-of-Date APIs/ Storage Management/ Obtaining the OBS Bucket List (To Be Discarded)
Updated on 2026-01-08 GMT+08:00

Obtaining the OBS Bucket List (To Be Discarded)

Function

This API is used to obtain the OBS bucket list of a user.

Calling Method

For details, see Calling APIs.

Authorization

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see the required permissions in Permissions Policies and Supported Actions.
  • If you are using identity policy-based authorization, no identity policy-based permissions are required for calling this API.

URI

GET /api/v3.1/storage/obs/buckets

Table 1 Query parameters

Parameter

Mandatory

Type

Description

region

No

String

Definition

(Optional) If this parameter is specified, the OBS resource list in the specified region will be returned. If this parameter is not specified, the OBS resource list in all regions will be returned.

For details about the AZs supported by OBS, see Regions and Endpoints.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Cluster-ID

No

String

Cluster ID. This parameter is mandatory when the URL format https://Endpoint/uri is used. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

[Array elements]

Array of ListBucketsItem objects

Definition

Bucket list details

Range

N/A

Table 4 ListBucketsItem

Parameter

Type

Description

Name

String

Definition

Bucket name

Range

N/A

CreationDate

String

Definition

Time when a bucket was created

Range

N/A

Location

String

Definition

AZ where a bucket resides

Range

N/A

Example Requests

Obtain the OBS bucket list of a user.

GET /api/v3.1/storage/obs/buckets

[ {
  "Name" : "cce-charts-cn-north-7-2c8ac3fe69c540919820dd679733d82e",
  "CreationDate" : "2025-11-14T08:21:07.706Z",
  "Location" : "cn-north-7"
} ]

Example Responses

Status code: 200

The OBS bucket list of the user has been obtained.

[ {
  "Name" : "cce-charts-cn-north-7-2c8ac3fe69c540919820dd679733d82e",
  "CreationDate" : "2025-11-14T08:21:07.706Z",
  "Location" : "cn-north-7"
} ]

Status Codes

Status Code

Description

200

The OBS bucket list of the user has been obtained.

Error Codes

See Error Codes.