Obtaining the OBS Bucket Details (To Be Discarded)

Function

This API is used to obtain the details of an OBS bucket.

Calling Method

For details, see Calling APIs.

Authorization

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

URI

GET /api/v3.1/storage/obs/buckets/{bucket_name}

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
bucket_name	Yes	String	Definition Bucket name Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Cluster-ID	No	String	Cluster ID. This parameter is mandatory when the URL format https://Endpoint/uri is used. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
name	String	Definition Bucket name Range N/A
storage_class	String	Definition Bucket type Range N/A
region	String	Definition AZ where a bucket resides Range N/A
obs_fs_file_interface	Boolean	Definition Whether a parallel file system is in use Range true: A parallel file system is in use. false: A parallel file system is not in use.
epid	String	Definition Enterprise project ID Range N/A
obs_bucket_redundancy	String	Definition Bucket redundancy Range N/A

Example Requests

Obtain a user's OBS bucket details.

GET /api/v3.1/storage/obs/buckets/{bucket_name}

{
  "name" : "cce-charts-cn-north-7-2c8ac3fe69c540919820dd679733d82e",
  "storage_class" : "standard",
  "region" : "cn-north-7",
  "obs_fs_file_interface" : false,
  "epid" : "0",
  "obs_bucket_redundancy" : ""
}

Example Responses

Status code: 200

The user's OBS bucket details have been obtained.

{
  "name" : "cce-charts-cn-north-7-2c8ac3fe69c540919820dd679733d82e",
  "storage_class" : "standard",
  "region" : "cn-north-7",
  "obs_fs_file_interface" : false,
  "epid" : "0",
  "obs_bucket_redundancy" : ""
}