Help Center/ Media Processing Center/ API Reference/ Authorization and Configuration APIs/ Querying Buckets
Updated on 2023-12-25 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Buckets

Function

Queries the list of buckets in a specified region.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/buckets

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID .

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token

The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Authorization

No

String

Authentication information. This parameter is mandatory when AK/SK-based authentication is used.

X-Project_Id

No

String

Project ID. This parameter is mandatory when AK/SK-based authentication is used. It is same as the project ID in path parameters.

X-Sdk-Date

No

String

Time when the request is sent. This parameter is mandatory when AK/SK-based authentication is used.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

buckets

Array of ObsBucket objects

Bucket list
Table 4 ObsBucket

Parameter

Type

Description

bucket

String

Bucket name

creation_date

String

Time when the bucket is created

is_authorized

Integer

Authorization result

The value can be 0 or 1.

  • 0: MPC is not authorized.

  • 1: MPC has been authorized.

Status code: 403

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error description

Example Requests

GET https://{endpoint}/v1/{project_id}/buckets

Example Responses

Status code: 200

The bucket list has been queried.

{
  "buckets" : [ {
    "bucket" : "example-bucket",
    "creation_date" : 20221026152511,
    "is_authorized" : 1
  }, {
    "bucket" : "example-bucket",
    "creation_date" : 20221026104736,
    "is_authorized" : 0
  } ]
}

Status code: 403

The bucket list cannot be queried.

{
  "error_code" : "MPC.10208",
  "error_msg" : "Failed to verify the tenant ID."
}

Status Codes

Status Code

Description

200

The bucket list has been queried.

403

The bucket list cannot be queried.

Error Codes

See Error Codes.

Parent Topic: Authorization and Configuration APIs