Obtaining the Direct Reading Configuration of a Bucket
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
| Parameter | Type | Mandatory (Yes/No) | Description |
|---|---|---|---|
| request | Yes | Explanation: Request parameters for obtaining the direct reading configuration of a bucket. For details, see Table 2. |
| Parameter | Type | Mandatory (Yes/No) | Description |
|---|---|---|---|
| bucketName | String | Yes | Explanation: Bucket name. Restrictions:
Default value: None |
Responses
| 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. |
Sample Code
This example obtains the direct reading configuration of a bucket.
import android.util.Log;
import com.obs.services.ObsClient;
import com.obs.services.exception.ObsException;
import com.obs.services.model.BucketDirectColdAccess;
import com.obs.services.model.BaseBucketRequest;
import com.obs.services.model.DirectColdAccessEnum;
// Note: Network operations must be performed in a child thread. Otherwise, NetworkOnMainThreadException will be thrown.
new Thread(() -> {
// Security warning: Hard-coded AK and SK are risky. You are advised to obtain the AK and SK from the security credential management system.
String ak = System.getenv("ACCESS_KEY_ID");
String sk = System.getenv("SECRET_ACCESS_KEY");
String endPoint = "https://obs.cn-north-4.myhuaweicloud.com";
ObsClient obsClient = null;
try {
obsClient = new ObsClient(ak, sk, endPoint);
String bucketName = "examplebucket";
// Obtain the direct reading configuration of a bucket.
BucketDirectColdAccess result = obsClient.getBucketDirectColdAccess(bucketName);
Log.i("ObsDemo", "Obtained the direct reading configuration of the bucket successfully. Direct reading configuration: " + result.getDirectColdAccess());
} catch (ObsException e) {
Log.e("ObsDemo", "Failed to obtain the direct reading configuration of the bucket. HTTP status code: " + e.getResponseCode()
+ ". Error code: " + e.getErrorCode()
+ ". Error message: " + e.getErrorMessage());
} finally {
if (obsClient != null) {
try {
obsClient.close();
} catch (Exception e) {
Log.e("ObsDemo", "Failed to close ObsClient.", e);
}
}
}
}).start(); What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot