Listing OBS Buckets

Function

This API is used to list OBS buckets.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

GET /v2/rtc-ops/buckets

Request Parameters

**Table 1** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API that is used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

**Table 2** Response header parameters
Parameter	Type	Description
X-request-Id	String	Request ID for task tracing.

**Table 3** Response body parameters
Parameter	Type	Description
count	Integer	Total number of buckets.
buckets	Array of ObsBucket objects	Bucket information.

**Table 4** ObsBucket
Parameter	Type	Description
bucket	String	OBS bucket name.
location	String	Region where the OBS bucket resides.
creation_date	String	Creation time, for example, 2020/07/16 15:11:55 GMT+08:00.
is_authorized	Boolean	Authentication.

Status code: 400

**Table 5** Response header parameters
Parameter	Type	Description
X-request-Id	String	Request ID for task tracing.

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Description.

Status code: 401

**Table 7** Response header parameters
Parameter	Type	Description
X-request-Id	String	Request ID for task tracing.

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Description.

Status code: 500

**Table 9** Response header parameters
Parameter	Type	Description
X-request-Id	String	Request ID for task tracing.

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Description.

Example Requests

None

Example Responses

Status code: 200

OBS buckets listed.

{
  "count" : 1,
  "buckets" : [ {
    "bucket" : "rtctest"
  }, {
    "location" : "cn-north-4"
  }, {
    "creation_date" : "20230808112928"
  }, {
    "is_authorized" : true
  } ]
}

Status code: 400

Failed to list OBS buckets.

{
  "error_code" : "RTC.00001003",
  "error_msg" : "InvalidParameterValue"
}

Status code: 401

Failed to list OBS buckets due to an incorrect X-Auth-Token.

{
  "error_code" : "RTC.00001003",
  "error_msg" : "InvalidParameterValue"
}

Status code: 500

Query failed due to a server error.

{
  "error_code" : "RTC.00002xxx",
  "error_msg" : "InternalError"
}

Status Codes

Status Code	Description
200	OBS buckets listed.
400	Failed to list OBS buckets.
401	Failed to list OBS buckets due to an incorrect X-Auth-Token.
500	Query failed due to a server error.

Error Codes

See Error Codes.

Parent topic: OBS Bucket Management

Previous topic: OBS Bucket Management

Next topic: Listing Objects in an OBS Bucket

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot