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

Configuring Direct Reading for a Bucket (SDK for Java)

Function

This API is used to configure direct reading for a bucket.

Restrictions

To configure direct reading for a bucket, you must be the bucket owner or have the required permission (obs:bucket:PutDirectColdAccessConfiguration granted using IAM or PutDirectColdAccessConfiguration 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.setBucketDirectColdAccess(SetBucketDirectColdAccessRequest request)

Request Parameters

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

**Table 2** SetBucketDirectColdAccessRequest
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 properties comply with those set in the first creation request. Default value: None
access	BucketDirectColdAccess	Yes	Explanation: Cross-region replication configuration of a bucket. Value range: For details, see Table 3. Default value: None

**Table 3** BucketDirectColdAccess
Parameter	Type	Mandatory (Yes/No)	Description
status	RuleStatusEnum	Yes	Explanation: Direct reading status of Archive objects in a bucket. Value range: For details, see Table 4. Default value: None

**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.

Responses

**Table 5** Common response headers
Parameter	Type	Description
statusCode	int	Explanation: HTTP status code. Value range: A status code is a group of digits that can be 2xx (indicating successes) or 4xx or 5xx (indicating errors). It indicates the status of a response. For more information, see Status Code. Default value: None
responseHeaders	Map<String, Object>	Explanation: HTTP response header list, composed of tuples. In a tuple, the String key indicates the name of the header, and the Object value indicates the value of the header. Default value: None

Code Examples

This example configures direct reading for Archive objects in 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 SetBucketDirectColdAccess {
    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 = new BucketDirectColdAccess(RuleStatusEnum.ENABLED);
            SetBucketDirectColdAccessRequest setBucketDirectColdAccessRequest = new SetBucketDirectColdAccessRequest(
                exampleBucket, access);
            obsClient.setBucketDirectColdAccess(setBucketDirectColdAccessRequest);
            System.out.println("SetBucketDirectColdAccess successfully");
        } catch (ObsException e) {
            System.out.println("SetBucketDirectColdAccess 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("SetBucketDirectColdAccess failed");
            // Print other error information.
            e.printStackTrace();
        }
    }
}

Parent topic: Direct Reading (SDK for Java)