Configuring an Online Decompression Policy (SDK for Node.js)

Function

OBS can automatically decompress uploaded ZIP packages and save them to a specified directory. If any ZIP package uploaded to a bucket matches the configured decompression policy, the package will be automatically decompressed to the specified directory. This API is used to configure a ZIP file decompression policy for a specified bucket. For more information about online decompression, see Online Decompression.

Online decompression is not available for fusion buckets.

Restrictions

Permissions

• To configure, obtain, or delete online decompression policies, you must have the Tenant Administrator permission assigned by using role/policy-based authorization of IAM.
• Online decompression requires that you create an IAM agency to delegate OBS to access data in the bucket. The permissions the agency should assign to OBS include obs:object:PutObject, obs:object:GetObject, and obs:object:AbortMultipartUpload.

Package and file size

• A single ZIP package cannot exceed 1 GB in size.
• A single ZIP package can contain a maximum of 65,536 files.
• A single decompressed file cannot exceed 40 GB in size.

Time

• Decompressing a ZIP package takes 10 minutes at most.

Functions

• Currently, only ZIP packages are supported.
• ZIP package names cannot contain Chinese punctuation marks, special characters, or special codes such as \/:*?"<>|@#¥.
• To decompress the ZIP package that contains other ZIP packages, the event type of the online decompression policy must be set to ObjectCreated:* or ObjectCreated:CompleteMultipartUpload.
• Currently, no notification will be sent to users after decompression tasks are complete.
• Currently, only deflate-compressed ZIP packages can be decompressed. Deflate is different from the compression algorithms (such as Store and Normal) provided by WinRAR.
• The total length of the decompression path plus the name of any decompressed file cannot exceed 512 characters.
• Currently, encrypted ZIP packages cannot be decompressed.
• Federated users cannot use online decompression. For more information about federated users, see Relationship Between Accounts and Users and Identity Provider Overview.

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

Method

ObsClient.setBucketCompressPolicy(params)

Request Parameters

Sample Code

You can call ObsClient.setBucketCompressPolicy to configure an online decompression policy. 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 setBucketCompressPolicy() {
  try {
    // Construct an online decompression rule (JSON string).
    const rules = JSON.stringify({
        rules: [{
            id: 'decompress-rule-001',
            project: 'your_projectId' ,
            agency: 'your_agency',
            events: ['ObjectCreated:*'],
            prefix: 'decompress/',
            suffix: '.zip',
            overwrite: 0,
            decompresspath: 'output/',
            policytype: 'decompress'
        }]
    });
    const params = {
      // Specify a bucket name.
      Bucket: "examplebucket",
      // Specify the online decompression rule.
      Rules: rules,
    };
    // Configure the online decompression policy.
    const result = await obsClient.setBucketCompressPolicy(params);
    if (result.CommonMsg.Status <= 300) {
      console.log("Set bucket compress policy 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);
  };
};

setBucketCompressPolicy();