文档首页/ 对象存储服务 OBS/ SDK参考/ C/ 桶相关接口(C SDK)/ 在线解压(C SDK)/ 设置在线解压策略(C SDK)
更新时间：2026-07-13 GMT+08:00
查看PDF
分享

设置在线解压策略(C SDK)

开发过程中，您有任何问题可以在GitHub上提交issue，或者在华为云对象存储服务论坛中发帖求助。

功能介绍

调用设置在线解压策略接口，您可为指定桶配置在线解压策略。在线解压策略可以在zip压缩包上传到桶时自动触发解压，将压缩包内的文件解压到指定路径，实现自动化数据处理。

接口约束

  • 您必须是桶拥有者或拥有设置在线解压策略的权限，才能设置在线解压策略。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:PutBucketCompressPolicy权限，如果使用桶策略则需授予PutBucketCompressPolicy权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、自定义创建桶策略。
  • OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。
  • 每个桶最多支持配置10条在线解压规则。

方法定义

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);

请求参数说明

表1 请求参数列表

参数名称

参数类型

是否必选

描述

options

const obs_options*

必选

参数解释：

请求桶的上下文，通过obs_options设置AK、SK、endpoint、bucket、超时时间、临时鉴权。

约束限制：

无

取值范围：

无

默认取值：

无

compress_policy_rules

表3 obs_server_side_encryption_rule*

必选

参数解释：

在线解压策略规则数组。

约束限制：

无

取值范围：

无

默认取值：

无

rule_number

unsigned int

必选

参数解释：

规则数量。

约束限制：

最多支持10条规则。

取值范围：

1~10。

默认取值：

无

handler

obs_response_handler *

必选

参数解释：

回调结构体，结构体内所有成员都是回调函数的指针，用于设置处理接口响应数据的回调函数。您可以通过设置回调函数，把服务端的响应数据复制到您的自定义回调数据callback_data中。

约束限制：

无

取值范围：

无

默认取值：

无

callback_data

void *

可选

参数解释：

用户自定义回调数据。

约束限制：

无

取值范围：

无

默认取值：

无
表2 obs_compress_policy_rule

参数名称

参数类型

是否必选

描述

id

char *

必选

参数解释：

规则ID，用于唯一标识一条解压规则。

约束限制：

仅支持字母、数字、下划线和中划线。

取值范围：

长度1~256，正则匹配：^[a-zA-Z0-9_-]{1,256}$。

默认取值：

无

project

char *

必选

参数解释：

项目ID，用于标识解压任务所属的项目。

约束限制：

无

取值范围：

无

默认取值：

无

agency

char *

必选

参数解释：

委托名称，用于授权OBS服务执行解压操作。

约束限制：

无

取值范围：

无

默认取值：

无

events

char **

必选

参数解释：

事件类型数组，指定触发解压的事件。

约束限制：

无

取值范围：

支持的事件类型如"ObjectCreated:*"、"ObjectCreated:Put"等。

默认取值：

无

events_number

unsigned int

必选

参数解释：

事件类型数量。

约束限制：

需与events数组长度一致。

取值范围：

大于0。

默认取值：

无

prefix

char *

可选

参数解释：

对象名前缀过滤器，仅匹配指定前缀的对象触发解压。

约束限制：

无

取值范围：

无

默认取值：

无，表示不限制前缀。

suffix

char *

必选

参数解释：

对象名后缀过滤器。

约束限制：

无

取值范围：

固定为".zip"。

默认取值：

无

overwrite

int

必选

参数解释：

覆盖模式，指定解压时同名文件的处理方式。

约束限制：

无

取值范围：

0（跳过）、1（按CRC32重命名）、2（覆盖）。

默认取值：

无

decompress_path

char *

可选

参数解释：

解压目标路径，指定解压后文件的存放路径。

约束限制：

非空时必须以"/"结尾。

取值范围：

无

默认取值：

无，表示解压到压缩包所在目录。

policy_type

char *

必选

参数解释：

策略类型。

约束限制：

无

取值范围：

固定为"decompress"。

默认取值：

无

代码示例

以下示例展示如何设置在线解压策略：

#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);
   // host_name填写桶所在的endpoint, 此处以华北-北京四为例，其他地区请按实际情况填写。
    options.bucket_options.host_name = "obs.cn-north-4.myhuaweicloud.com";
    // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；
    // 本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量ACCESS_KEY_ID和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";
    // 设置在线解压策略规则
    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); }
}

相关链接

  • 关于设置在线解压策略的API说明，请参见设置在线解压策略。
  • 设置在线解压策略过程中返回的错误码含义、问题原因及处理措施可参考OBS错误码。
父主题： 在线解压(C SDK)

相关文档