Updated on 2026-08-14 GMT+08:00

Obtaining the Direct Reading Configuration of a Bucket (SDK for Java)

Function

This API is used to obtain the direct reading configuration of a bucket.

Restrictions

To obtain the direct reading configuration of a bucket, you must be the bucket owner or have the required permission (obs:bucket:GetDirectColdAccessConfiguration granted using IAM or GetDirectColdAccessConfiguration granted using a bucket policy). For details, see Introduction to OBS Access Control, IAM Custom Policies, and Creating a Custom Bucket Policy.
The mapping between OBS regions and endpoints must comply with what is listed in Regions and Endpoints.

Method

obsClient.getBucketDirectColdAccess(BaseBucketRequest request)

Request Parameters

**Table 1** List of request parameters
Parameter	Type	Mandatory (Yes/No)	Description
request	BaseBucketRequest	Yes	Explanation: Request parameters for obtaining the direct reading configuration of a bucket. For details, see Table 2.

**Table 2** BaseBucketRequest
Parameter	Type	Mandatory (Yes/No)	Description
bucketName	String	Yes	Explanation: Bucket name. Restrictions: A bucket name must be unique across all accounts and regions. A bucket name: Must be 3 to 63 characters long and start with a digit or letter. Lowercase letters, digits, hyphens (-), and periods (.) are allowed. Cannot be formatted as an IP address. Cannot start or end with a hyphen (-) or period (.). Cannot contain two consecutive periods (..), for example, my..bucket. Cannot contain a period (.) and a hyphen (-) adjacent to each other, for example, my-.bucket or my.-bucket. If you repeatedly create buckets of the same name in the same region, no error will be reported and the bucket attributes comply with those set in the first creation request. Default value: None

Responses

**Table 3** BucketDirectColdAccess
Parameter	Type	Description
status	RuleStatusEnum	Explanation: Direct reading status of a bucket. If direct reading has never been configured for a bucket or the direct reading configuration has been deleted, no direct reading status will be returned. Value range: For details, see Table 4.

**Table 4** RuleStatusEnum
Constant	Default Value	Description
ENABLED	Enabled	Direct reading is enabled for a bucket.
DISABLED	Disabled	Direct reading is disabled for a bucket.

Code Examples

This example obtains the direct reading configuration of a bucket.

import com.obs.services.ObsClient;
import com.obs.services.exception.ObsException;
import com.obs.services.model.BucketDirectColdAccess;
import com.obs.services.model.RuleStatusEnum;
import com.obs.services.model.SetBucketDirectColdAccessRequest;

public class GetBucketDirectColdAccess {
    public static void main(String[] args) {
        // Obtain an AK/SK pair using environment variables or import the AK/SK pair in other ways. Using hard coding may result in leakage.
        // Obtain an AK/SK pair on the management console.
        String ak = System.getenv("ACCESS_KEY_ID");
        String sk = System.getenv("SECRET_ACCESS_KEY_ID");
        // (Optional) If you are using a temporary AK/SK pair and a security token to access OBS, you are advised not to use hard coding, which may result in information leakage.
        // Obtain an AK/SK pair and a security token using environment variables or import them in other ways.
        // String securityToken = System.getenv("SECURITY_TOKEN");
        // Enter the endpoint corresponding to the bucket. CN-Hong Kong is used here as an example. Replace it with the one currently in use.
        String endPoint = "https://obs.ap-southeast-1.myhuaweicloud.com";
        // Obtain an endpoint using environment variables or import it in other ways.
        // String endPoint = System.getenv("ENDPOINT");
        
        // Create an ObsClient instance.
        // Use a permanent AK/SK pair to initialize the client.
        ObsClient obsClient = new ObsClient(ak, sk, endPoint);
        // Use a temporary AK/SK pair and security token to initialize the client.
        // ObsClient obsClient = new ObsClient(ak, sk, securityToken, endPoint);
        try {
            String exampleBucket = "exampleBucket";
            BucketDirectColdAccess access = obsClient.getBucketDirectColdAccess(exampleBucket);
            System.out.println("Access status:"+ access.getStatus() );
            System.out.println("GetBucketDirectColdAccess successfully");
        } catch (ObsException e) {
            System.out.println("GetBucketDirectColdAccess failed");
            // Request failed. Print the HTTP status code.
            System.out.println("HTTP Code:" + e.getResponseCode());
            // Request failed. Print the server-side error code.
            System.out.println("Error Code:" + e.getErrorCode());
            // Request failed. Print the error details.
            System.out.println("Error Message:" + e.getErrorMessage());
            // Request failed. Print the request ID.
            System.out.println("Request ID:" + e.getErrorRequestId());
            System.out.println("Host ID:" + e.getErrorHostId());
            e.printStackTrace();
        } catch (Exception e) {
            System.out.println("GetBucketDirectColdAccess failed");
            // Print other error information.
            e.printStackTrace();
        }
    }
}

Parent topic: Direct Reading (SDK for Java)