Obtaining the Bucket List

Function

This API is used to obtain the buckets to which data is dumped.

Calling Method

For details, see Calling APIs.

URI

GET /v1/obs/buckets

Request Parameters

**Table 1** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. For details, see Token-based Authentication. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
bucketName	String	Definition Bucket name Constraints N/A Range N/A Default Value N/A
owner	String	Definition Bucket owner Constraints N/A Range N/A Default Value N/A
creationDate	Integer	Definition Bucket creation time, which is a UNIX timestamp Constraints N/A Range N/A Default Value N/A
location	String	Definition ID of the current region Constraints N/A Range N/A Default Value N/A

**Table 3** BucketOwnerResult
Parameter	Type	Description
displayName	String	Definition Displayed username, which is the domain name of the user who owns the bucket Constraints N/A Range N/A Default Value N/A
id	String	Definition User ID, which is the domain ID of the user who owns the bucket Constraints N/A Range N/A Default Value N/A

Example Requests

Obtain the bucket list.

GET https://{Endpoint}/v1/obs/buckets

Example Responses

Status code: 200

Success

{
  "bucketName" : "dis-test",
  "owner" : {
    "displayName" : null,
    "id" : "b2dbbd927c504f75885b7edc67xxx15e"
  },
  "creationDate" : 1646829844714,
  "location" : "cn-soutxxx-x",
  "clustertype" : null,
  "storageClass" : null,
  "acl" : null,
  "bucketStorageClass" : null,
  "bucketType" : "OBJECT"
}