Obtaining the Default WORM Policy of a Bucket (SDK for Node.js)

Function

This API is used to obtain the default WORM policy of a bucket.

If you have never configured the default bucket-level retention policy after enabling WORM for a bucket, you can still use this API to check whether WORM is enabled.

Restrictions

• To obtain the default WORM policy of a bucket, you must be the bucket owner or have the required permission (obs:bucket:GetBucketObjectLockConfiguration granted using IAM or GetBucketObjectLockConfiguration 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.getObjectLockConfiguration(params)

Request Parameters

Sample Code

You can call ObsClient.getObjectLockConfiguration to obtain the default WORM policy of 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 getObjectLockConfiguration() {
  try {
    const params = {
      // Specify a bucket name.
      Bucket: "examplebucket",
    };
    // Obtain the default WORM policy of the bucket.
    const result = await obsClient.getObjectLockConfiguration(params);
    if (result.CommonMsg.Status <= 300) {
      console.log("Get object lock configuration successful!");
      console.log("RequestId: %s", result.CommonMsg.RequestId);
      if (result.InterfaceResult) {
        console.log("ObjectLockEnabled: %s", result.InterfaceResult.ObjectLockEnabled);
        const rule = result.InterfaceResult.Rule;
        if (rule && rule.DefaultRetention) {
          console.log("Mode: %s", rule.DefaultRetention.Mode);
          console.log("Days: %s", rule.DefaultRetention.Days);
        }
      }
      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);
  };
};

getObjectLockConfiguration();