更新时间:2026-07-13 GMT+08:00
分享

获取在线解压策略(C SDK)

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

功能介绍

调用获取在线解压策略接口,您可以获取指定桶的在线解压策略配置信息,包括所有解压规则的详细配置。

接口约束

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

方法定义

void get_bucket_compress_policy(const obs_options *options,
    obs_get_bucket_compress_policy_handler *handler, void *callback_data);

请求参数说明

表1 请求参数列表

参数名称

参数类型

是否必选

描述

options

const obs_options*

必选

参数解释:

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

约束限制:

取值范围:

默认取值:

handler

表2*

必选

参数解释:

回调结构体,包含响应回调、结束回调和获取在线解压策略的回调。

约束限制:

取值范围:

默认取值:

callback_data

void *

可选

参数解释:

用户自定义回调数据。

约束限制:

取值范围:

默认取值:

表2 obs_get_bucket_compress_policy_handler

参数名称

参数类型

是否必选

描述

response_handler

obs_response_handler

必选

参数解释:

响应回调函数结构体。

约束限制:

取值范围:

默认取值:

get_bucket_compress_policy_callback

表3*

必选

参数解释:

桶加密配置回调函数指针,可以在这个回调中把encryption_config的内容记录到callback_data中。

约束限制:

取值范围:

默认取值:

表3 obs_get_bucket_compress_policy_callback

参数名称

参数类型

是否必选

描述

compress_policy_rules

表3 obs_server_side_encryption_rule*

必选

参数解释:

在线解压策略规则数组。

约束限制:

取值范围:

默认取值:

rule_number

unsigned int

必选

参数解释:

规则数量。

约束限制:

最多支持10条规则。

取值范围:

1~10。

默认取值:

callback_data

void *

必选

参数解释:

用户自定义回调数据指针。

约束限制:

取值范围:

默认取值:

表4 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"。

默认取值:

代码示例

以下示例展示如何获取在线解压策略:
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
#include "eSDKOBS.h"
#include <stdio.h>
#include <string.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);
typedef struct CompressPolicyResult
{
    obs_compress_policy_rule *rules;
    unsigned int rule_count;
    obs_status ret_status;
} CompressPolicyResult;
obs_status get_compress_policy_callback(obs_compress_policy_rule *rules_return,
                                         unsigned int rule_number, void *callback_data)
{
    CompressPolicyResult *result = (CompressPolicyResult *)callback_data;
    result->rules = rules_return;
    result->rule_count = rule_number;
    return OBS_STATUS_OK;
}
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_get_bucket_compress_policy_handler handler = {0};
    handler.response_handler.properties_callback = &response_properties_callback;
    handler.response_handler.complete_callback = &response_complete_callback;
    handler.get_bucket_compress_policy_callback = &get_compress_policy_callback;
    CompressPolicyResult result;
    memset(&result, 0, sizeof(CompressPolicyResult));
    result.ret_status = OBS_STATUS_BUTT;
    get_bucket_compress_policy(&options, &handler, &result);
    if (OBS_STATUS_OK == result.ret_status) {
        printf("get bucket compress policy successfully.\n");
        printf("rule count: %u\n", result.rule_count);
        for (unsigned int i = 0; i < result.rule_count; i++) {
            printf("rule[%u]: id=%s, suffix=%s, overwrite=%d, decompress_path=%s, policy_type=%s\n",
                   i,
                   result.rules[i].id ? result.rules[i].id : "(null)",
                   result.rules[i].suffix ? result.rules[i].suffix : "(null)",
                   result.rules[i].overwrite,
                   result.rules[i].decompress_path ? result.rules[i].decompress_path : "(null)",
                   result.rules[i].policy_type ? result.rules[i].policy_type : "(null)");
        }
    } else {
        printf("get bucket compress policy failed(%s).\n", obs_get_status_name(result.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) {
        CompressPolicyResult *result = (CompressPolicyResult *)callback_data;
        result->ret_status = status;
    }
    if (error && error->message) { printf("Error: %s\n", error->message); }
}

相关链接

  • 关于获取在线解压策略的API说明,请参见获取在线解压策略
  • 获取在线解压策略过程中返回的错误码含义、问题原因及处理措施可参考OBS错误码

相关文档