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

Function

This API is used to query the file decompression policy of a specified bucket. If the policy exists, a success message is returned with status code 200. For more information about online decompression, see Online Decompression.

Restrictions

• 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.

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

Method

ObsClient.getBucketCompressPolicy(params)

Request Parameters

Responses

Sample Code

You can call ObsClient.getBucketCompressPolicy to obtain 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 getBucketCompressPolicy() {
  try {
    const params = {
      // Specify a bucket name.
      Bucket: "examplebucket",
    };
    // Obtain the online decompression policy.
    const result = await obsClient.getBucketCompressPolicy(params);
    if (result.CommonMsg.Status <= 300) {
      console.log("Get bucket compress policy successful!");
      console.log("RequestId: %s", result.CommonMsg.RequestId);
      if (result.InterfaceResult && result.InterfaceResult.Rules) {
        // The value of Rules is a JSON string and needs to be parsed before being used.
        const rules = JSON.parse(result.InterfaceResult.Rules);
        console.log("Compress rules: %s", JSON.stringify(rules, null, 2));
      }
      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);
  };
};

getBucketCompressPolicy();