Configuring an Online Decompression Policy (SDK for C)

Function

This API is used to configure an online decompression policy for a specified bucket. With an online decompression policy, a ZIP package is automatically decompressed to a specified path when it is uploaded to a bucket. This enables automatic data processing.

Restrictions

• To configure an online decompression policy for a bucket, you must be the bucket owner or have the required permission (obs:bucket:PutBucketCompressPolicy granted using IAM or PutBucketCompressPolicy 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.
• A maximum of 10 online decompression rules can be configured for a bucket.

Method

void set_bucket_compress_policy(const obs_options *options,
    obs_compress_policy_rule *compress_policy_rules,
    unsigned int rule_number,
    obs_response_handler *handler, void *callback_data);

Request Parameters

Sample Code

This example configures an online decompression policy for a bucket.

#include "eSDKOBS.h"
#include <stdio.h>
obs_status response_properties_callback(const obs_response_properties *properties, void *callback_data);
void response_complete_callback(obs_status status, const obs_error_details *error, void *callback_data);
int main()
{
    obs_initialize(OBS_INIT_ALL);
    obs_options options;
    init_obs_options(&options);
    // Enter the endpoint corresponding to the bucket for host_name. CN-Hong Kong is used here as an example. Replace it with the one currently in use.
    options.bucket_options.host_name = "obs.ap-southeast-1.myhuaweicloud.com";
    // Hard-coded or plaintext AK and SK are risky. For security purposes, encrypt your AK and SK and store them in the configuration file or environment variables.
    // In this example, the AK and SK are stored in environment variables for identity authentication. Before running the code in this example, configure local environment variables ACCESS_KEY_ID and SECRET_ACCESS_KEY.
    options.bucket_options.access_key = getenv("ACCESS_KEY_ID");
    options.bucket_options.secret_access_key = getenv("SECRET_ACCESS_KEY");
    options.bucket_options.bucket_name = "example-bucket-name";
    // Configure an online decompression rule.
    obs_compress_policy_rule rule = {0};
    rule.id = "decompress-rule-001";
    rule.project = "your-project-id";
    rule.agency = "your-agency-name";
    const char* events[] = {"ObjectCreated:*"};
    rule.events = (char**)events;
    rule.events_number = 1;
    rule.prefix = "zip-files/";
    rule.suffix = ".zip";
    rule.overwrite = 0;
    rule.decompress_path = "unzipped/";
    rule.policy_type = "decompress";
    obs_response_handler response_handler = {&response_properties_callback, &response_complete_callback};
    obs_status ret_status = OBS_STATUS_BUTT;
    set_bucket_compress_policy(&options, &rule, 1, &response_handler, &ret_status);
    if (OBS_STATUS_OK == ret_status) {
        printf("set bucket compress policy successfully.\n");
    } else {
        printf("set bucket compress policy failed(%s).\n", obs_get_status_name(ret_status));
    }
    obs_deinitialize();
}
obs_status response_properties_callback(const obs_response_properties *properties, void *callback_data)
{
    (void)properties; (void)callback_data;
    return OBS_STATUS_OK;
}
void response_complete_callback(obs_status status, const obs_error_details *error, void *callback_data)
{
    if (callback_data) { *(obs_status*)callback_data = status; }
    if (error && error->message) { printf("Error: %s\n", error->message); }
}

Helpful Links

• The API for configuring an online decompression policy
• OBS Error Codes