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

设置DIS通知策略(C SDK)

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

功能介绍

DIS通知策略是OBS提供的事件通知功能。调用设置桶DIS通知策略接口,您可为指定桶配置DIS通知规则,当桶内对象发生指定事件时,OBS会将事件信息推送到DIS数据通道中。

接口约束

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

方法定义

void set_bucket_dis_policy(const obs_options *options,
    obs_dis_policy_rule *dis_policy_rules,
    unsigned int rule_number,
    obs_response_handler *handler, void *callback_data);

请求参数说明

表1 请求参数列表

参数名称

参数类型

是否必选

描述

options

const obs_options*

必选

参数解释:

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

约束限制:

取值范围:

默认取值:

dis_policy_rules

表2 *

必选

参数解释:

DIS通知策略规则数组,每条规则定义了事件类型、DIS通道及过滤条件。

约束限制:

取值范围:

默认取值:

rule_number

unsigned int

必选

参数解释:

DIS通知策略规则的数量。

约束限制:

取值范围:

1~10

默认取值:

handler

obs_response_handler *

必选

参数解释:

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

约束限制:

取值范围:

默认取值:

callback_data

void *

可选

参数解释:

用户自定义回调数据。

约束限制:

取值范围:

默认取值:

表2 obs_dis_policy_rule

参数名称

参数类型

是否必选

描述

id

char *

必选

参数解释:

规则ID,在桶内唯一标识一条DIS通知规则。

约束限制:

取值范围:

长度为1~256的字符串,匹配正则表达式^[a-zA-Z0-9_-]{1,256}$。

默认取值:

stream

char *

必选

参数解释:

DIS数据通道名称,事件信息将推送到该通道中。

约束限制:

取值范围:

默认取值:

project

char *

必选

参数解释:

项目ID(租户ID),用于标识DIS通道所属的项目。

约束限制:

取值范围:

默认取值:

agency

char *

必选

参数解释:

委托名称,用于跨账号授权OBS将事件推送到DIS通道。

约束限制:

取值范围:

默认取值:

events

char **

必选

参数解释:

事件类型数组,指定需要通知的事件类型。

约束限制:

取值范围:

ObjectCreated:、ObjectCreated:Put、ObjectCreated:Post、ObjectCreated:Copy、ObjectCreated:CompleteMultipartUpload、ObjectRemoved:、ObjectRemoved:Delete、ObjectRemoved:DeleteMarkerCreated。

默认取值:

events_number

unsigned int

必选

参数解释:

事件类型数组的元素个数。

约束限制:

取值范围:

1~10

默认取值:

prefix

char *

可选

参数解释:

对象名前缀过滤规则,仅对匹配该前缀的对象生效。

约束限制:

取值范围:

默认取值:

suffix

char *

可选

参数解释:

对象名后缀过滤规则,仅对匹配该后缀的对象生效。

约束限制:

取值范围:

默认取值:

代码示例

以下示例展示如何设置桶DIS通知策略。
#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";
    // 配置DIS通知策略规则
    char *events[] = {"ObjectCreated:*"};
    obs_dis_policy_rule rule = {0};
    rule.id = "rule1";
    rule.stream = "dis-stream-example";
    rule.project = "project-id-example";
    rule.agency = "agency-example";
    rule.events = events;
    rule.events_number = 1;
    rule.prefix = "data/";
    rule.suffix = NULL;
    obs_dis_policy_rule dis_policy_rules[] = {rule};
    obs_response_handler response_handler = {&response_properties_callback, &response_complete_callback};
    obs_status ret_status = OBS_STATUS_BUTT;
    // 设置桶DIS通知策略
    set_bucket_dis_policy(&options, dis_policy_rules, 1, &response_handler, &ret_status);
    if (OBS_STATUS_OK == ret_status) {
        printf("set bucket dis policy successfully.\n");
    } else {
        printf("set bucket dis 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); }
}

相关链接

  • 设置桶DIS通知策略过程中返回的错误码含义、问题原因及处理措施可参考OBS错误码

相关文档