Configuring WORM Retention for an Object (SDK for Node.js)

Function

This API is used to configure or modify the retention period for objects uploaded to a bucket with WORM enabled.

• If you did not configure a retention period or apply the default bucket-level retention policy when uploading an object, you can perform this operation to configure a retention period for the object.
• If you already configured a retention period or applied the default bucket-level retention policy when uploading an object, you can perform this operation to prolong the retention period for the object.
• The retention period of an object can only be modified, but not deleted.

Restrictions

• To configure WORM retention for an object, you must be the bucket owner or have the required permission (obs:object:PutObjectRetention granted using IAM or PutObjectRetention granted using a bucket policy). For details, see Introduction to OBS Access Control, IAM Custom Policies, and Configuring an Object Policy.
• The mapping between OBS regions and endpoints must comply with what is listed in Regions and Endpoints.

Method

ObsClient.setObjectRetention(params)

Request Parameters

Responses

Sample Code

You can call ObsClient.setObjectRetention to configure WORM retention for an object. 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 setObjectRetention() {
  try {
    // Calculate the retention expiration time by adding thirty days to the current time. The result is expressed as a timestamp in milliseconds.
    const retainUntilDate = Date.now() + 30 * 24 * 60 * 60 * 1000;
    const params = {
      // Specify a bucket name.
      Bucket: "examplebucket",
      // Specify an object name.
      Key: "objectname.txt",
      // Specify a retention mode.
      Mode: "COMPLIANCE",
      // Specify the retention expiration time.
      RetainUntilDate: retainUntilDate,
    };
    // Configure WORM retention for the object.
    const result = await obsClient.setObjectRetention(params);
    if (result.CommonMsg.Status <= 300) {
      console.log("Set object retention 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);
  };
};

setObjectRetention();