Querying the OBS Bucket List

Function

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

Calling Method

For details, see Calling APIs.

Authorization Information

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 Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v1.0/dms/obs/buckets

Request Parameters

None

Response Parameters

Status code: 200

**Table 1** Response body parameters
Parameter	Type	Description
responseHeaders	Object	Definition Response headers. Range N/A
originalHeaders	Object	Definition Original response headers. Range N/A
statusCode	Integer	Definition Status code. Range N/A
bucketName	String	Definition Bucket name. Range N/A
owner	Object	Definition Bucket owner information. Range N/A
creationDate	Integer	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. Range N/A
acl	String	Definition Bucket ACL policy. Range N/A
bucketStorageClass	String	Definition Bucket storage class. Range STANDARD: OBS 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"
} ]