Configuring a Storage Class for a Bucket¶
Function¶
This API configures a storage class for a bucket. If you do not specify a storage class when uploading or copying an object, or initiating a multipart upload, the object inherits the bucket's storage class.
The following table lists the three available storage classes.
Storage Class | Description | Value in OBS Java SDK |
|---|---|---|
Standard | Features low access latency and high throughput and is used for storing massive, frequently accessed (multiple times a month) or small objects (< 1 MB) requiring quick response. | StorageClassEnum.STANDARD |
Restrictions¶
To configure a storage class for a bucket, you must be the bucket owner or have the required permission (obs:PutBucketStoragePolicy in IAM or PutBucketStoragePolicy in a bucket policy).
The bucket storage class is independent from the storage classes of objects in the bucket. When uploading an object, if you do not specify a storage class for the object, the object will use the same storage class that the bucket uses. However, after the object is uploaded, its storage class will not change as that of the bucket changes. Likewise, the storage class of the bucket will also not change if the storage class of any objects therein changes.
Method¶
obsClient.setBucketStoragePolicy(String bucketName, BucketStoragePolicyConfiguration bucketStorage)
Request Parameters¶
Parameter | Type | Mandatory (Yes/No) | Description |
|---|---|---|---|
bucketName | String | Yes | Explanation: Bucket name. Restrictions:
Default value: None |
bucketStorage | BucketStoragePolicyConfiguration (Inheriting HeaderResponse) | Yes | Explanation: Storage class of the bucket. Value range: See Table 2. Default value: None |
Parameter | Type | Description |
|---|---|---|
storageClass | Explanation: Storage class of the bucket. Value range: See Table 3. Default value: None |
Constant | Default Value | Description |
|---|---|---|
STANDARD | STANDARD | Standard storage class. |
WARM | WARM | Warm storage class. |
COLD | COLD | Cold storage class. |
Responses¶
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. 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 a storage class for bucket exampleBucket.
import com.obs.services.ObsClient;
import com.obs.services.exception.ObsException;
import com.obs.services.model.AccessControlList;
import com.obs.services.model.AvailableZoneEnum;
import com.obs.services.model.CreateBucketRequest;
import com.obs.services.model.ObsBucket;
import com.obs.services.model.StorageClassEnum;
public class CreateBucket001 {
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 region where the bucket is to be created.
String endPoint = "https://your-endpoint";
// Obtain an endpoint using environment variables or import it in other ways.
//String endPoint = System.getenv("ENDPOINT");
// Create an ObsClient instance.
// Use the permanent AK/SK pair to initialize the client.
ObsClient obsClient = new ObsClient(ak, sk,endPoint);
// Use the temporary AK/SK pair and security token to initialize the client.
// ObsClient obsClient = new ObsClient(ak, sk, securityToken, endPoint);
try {
CreateBucketRequest request = new CreateBucketRequest();
// Example bucket name
String exampleBucket = "examplebucket";
// Example bucket location
request.setBucketName(exampleBucket);
// Set the bucket ACL to Private (the default value).
request.setAcl(AccessControlList.REST_CANNED_PRIVATE);
// Set the bucket storage class to Standard.
request.setBucketStorageClass(StorageClassEnum.STANDARD);
request.setLocation(exampleLocation);
// Create a bucket.
ObsBucket bucket = obsClient.createBucket(request);
// The bucket is created.
System.out.println("CreateBucket successfully");
System.out.println("RequestId:"+bucket.getRequestId());
} catch (ObsException e) {
System.out.println("CreateBucket 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());
} catch (Exception e) {
System.out.println("CreateBucket failed");
// Print other error information.
e.printStackTrace();
}
}
}