Help Center/ EventGrid/ API Reference/ APIs/ OBS Bucket Management/ Obtaining the OBS Bucket List
Updated on 2025-08-15 GMT+08:00
View PDF

Obtaining the OBS Bucket List

Function

This API is used to obtain the list of OBS buckets.

URI

GET /v1/{project_id}/subscriptions/obsbuckets

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Tenant resource space ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Offset, which is the position where the query starts. The value must be greater than or equal to 0.

limit

No

Integer

Number of records displayed on each page. The value must be within the range [1, 1000].

sort

No

String

Sorting mode of the query results.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

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.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total

Integer

Total number of records.

size

Integer

Number of records displayed on the current page.

items

Array of ObsBucketInfo objects

Object list.
Table 5 ObsBucketInfo

Parameter

Type

Description

responseHeaders

Object

Response header.

originalHeaders

Object

Request header.

statusCode

Integer

Status.

bucketName

String

Bucket name.

owner

owner object

Owner of the bucket.

creationDate

String

Time when the bucket is created.

location

String

Location of the bucket.

storageClass

Object

Storage class of the object.

metadata

Object

Bucket metadata.

acl

Object

Bucket ACL.

bucketStorageClass

Object

Storage class of the bucket.

bucketType

String

Bucket type.

requestId

String

Request ID.
Table 6 owner

Parameter

Type

Description

displayName

String

Label of the bucket.

id

String

Domain ID (account ID).

Example Requests

Obtain the OBS bucket list.

GET https://{eg_endpoint}/v1/{project_id}/subscriptions/obsbuckets

Example Responses

Status code: 200

Operation successful.

{
  "total" : 1,
  "size" : 1,
  "items" : [ { } ]
}

Status Codes

Status Code

Description

200

Operation successful.

Error Codes

See Error Codes.

Parent topic: OBS Bucket Management