Help Center/ Distributed Message Service for Kafka/ API Reference/ APIs V2 (Recommended)/ Smart Connect/ Querying the OBS Bucket List
Updated on 2026-03-16 GMT+08:00
View PDF

Querying the OBS Bucket List

Function

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

Calling Method

For details, see Calling APIs.

URI

GET /v1.0/dms/obs/buckets

Request Parameters

None

Response Parameters

Status code: 200

Table 1 Response body parameters

Parameter

Type

Description

[items]

Array of ObsBucketEntity objects

OBS bucket query list.
Table 2 ObsBucketEntity

Parameter

Type

Description

responseHeaders

Object

Definition

Response headers.

originalHeaders

Object

Definition

Original response headers.

statusCode

Integer

Definition

Status code.

Range

N/A

bucketName

String

Definition

Bucket name.

Range

N/A

owner

Object

Definition

Bucket owner information.

creationDate

Long

Definition

Time when the bucket was created.

Range

A string of 24 characters.

location

String

Definition

Region where the bucket is located.

Range

N/A

clustertype

String

Definition

Cluster type.

Range

N/A

storageClass

String

Definition

Storage type.

Range

N/A

metadata

Object

Definition

Metadata.

acl

String

Definition

Bucket ACL policy.

Range

N/A

bucketStorageClass

String

Definition

Bucket storage class.

Range

  • STANDARD: Standard

  • WARM: OBS Infrequent Access

  • COLD: Archive

  • DEEP_ARCHIVE: Deep Archive storage (limited OBT)

bucketType

String

Definition

Bucket type.

Range

N/A

requestId

String

Definition

Request ID.

Range

N/A

Example Requests

GET https://{endpoint}/v1.0/dms/obs/buckets

Example Responses

Status code: 200

OBS bucket list queried.

[ {
  "responseHeaders" : { },
  "originalHeaders" : { },
  "statusCode" : 0,
  "bucketName" : "test",
  "owner" : "{\"displayName\":null,\"id\":\"f6aeefc68918498ba6dea7c50d24d250\"}",
  "creationDate" : 1597993512727,
  "location" : "xx-xxx-xx",
  "clustertype" : "2020-05-15T03:19:51.065Z",
  "storageClass" : null,
  "metadata" : { },
  "acl" : null,
  "bucketStorageClass" : null,
  "bucketType" : "OBJECT",
  "requestId" : "8abfa7b372160bfd017216560af83e6e"
} ]

Status Codes

Status Code

Description

200

OBS bucket list queried.

Error Codes

See Error Codes.

Parent Topic: Smart Connect