Configuring a Default WORM Policy for a Bucket (SDK for Node.js)

Function

This API is used to configure a default Write-Once-Read-Many (WORM) retention policy and retention period for a bucket.

With a bucket's default WORM policy, if you do not specify a retention policy or retention period when you upload an object to the bucket, the default policy will be automatically applied to the newly uploaded object. An object-level WORM policy requires configuring a specific date, which indicates that an object will be protected until that date. For a default bucket-level WORM policy, a retention period is required, and the protection for an object starts when the object is uploaded to the bucket.

• You can modify or even delete the default WORM policy of a bucket. The change applies only to the objects uploaded after the change, but not to those uploaded before.
• During a multipart upload, the object parts uploaded are not protected before they are assembled. After object parts are assembled, the new object is protected by the default bucket-level WORM policy. You can also configure an object-level WORM policy for the new object.

Restrictions

• To configure a default WORM policy for a bucket, you must be the bucket owner or have the required permission (obs:bucket:PutBucketObjectLockConfiguration granted using IAM or PutBucketObjectLockConfiguration granted using a bucket policy). For details, see Introduction to OBS Access Control, IAM Custom Policies, and Creating a Custom Bucket Policy.

• The WORM mode can only be COMPLIANCE.
• The retention period can be set to 1 to 36500 days or 1 to 100 years.

• The mapping between OBS regions and endpoints must comply with what is listed in Regions and Endpoints.

Method

ObsClient.setObjectLockConfiguration(params)

Request Parameters

Responses

Sample Code

You can call ObsClient.setObjectLockConfiguration to configure a default WORM policy for a bucket. The sample code is as follows:

// Import the OBS library.
// Use npm for installation.
const ObsClient = require("esdk-obs-nodejs");
// Use the source code for installation.
// var ObsClient = require('./lib/obs');

// Create an ObsClient instance.
const obsClient = new ObsClient({
  // Obtain an AK and SK pair using environment variables (recommended) or import it in other ways. Using hard coding may result in leakage.
  // Obtain an AK/SK pair on the management console. For details, see https://support.huaweicloud.com/intl/en-us/usermanual-ca/ca_01_0003.html.
  access_key_id: process.env.ACCESS_KEY_ID,
  secret_access_key: process.env.SECRET_ACCESS_KEY,
  // (Optional) If you use a temporary AK/SK pair and a security token to access OBS, you are not advised to use hard coding, which may result in information leakage. You can obtain an AK/SK pair using environment variables or import an AK/SK pair in other ways.
  // security_token: process.env.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.
  server: "https://obs.ap-southeast-1.myhuaweicloud.com"
});

async function setObjectLockConfiguration() {
  try {
    const params = {
      // Specify a bucket name.
      Bucket: "examplebucket",
      // Specify whether to enable bucket-level WORM.
      ObjectLockEnabled: "Enabled",
      // Specify the default retention rule.
      Rule: {
        DefaultRetention: {
          Mode: "COMPLIANCE",
          Days: 30
        }
      }
    };
    // Configure the default WORM policy for the bucket.
    const result = await obsClient.setObjectLockConfiguration(params);
    if (result.CommonMsg.Status <= 300) {
      console.log("Set object lock configuration successful!\n");
      console.log("RequestId: %s", result.CommonMsg.RequestId);
      return;
    };
    console.log("An ObsError was found, which means your request sent to OBS was rejected with an error response.");
    console.log("Status: %d", result.CommonMsg.Status);
    console.log("Code: %s", result.CommonMsg.Code);
    console.log("Message: %s", result.CommonMsg.Message);
    console.log("RequestId: %s", result.CommonMsg.RequestId);
  } catch (error) {
    console.log("An Exception was found, which means the client encountered an internal problem when attempting to communicate with OBS, for example, the client was unable to access the network.");
    console.log(error);
  };
};

setObjectLockConfiguration();