获取DIS通知策略(C SDK)
开发过程中,您有任何问题可以在GitHub上提交issue。
功能介绍
调用获取桶DIS通知策略接口,您可获取指定桶的DIS通知策略配置。
接口约束
- 您必须是桶拥有者或拥有获取桶DIS通知策略的权限,才能获取桶DIS通知策略。建议使用IAM或桶策略进行授权,如果使用IAM则需授予obs:bucket:GetBucketDisPolicy权限,如果使用桶策略则需授予GetBucketDisPolicy权限。相关授权方式介绍可参见OBS权限控制概述,配置方式详见使用IAM自定义策略、自定义创建桶策略。
- OBS支持的Region与Endpoint的对应关系,详细信息请参见地区与终端节点。
方法定义
void get_bucket_dis_policy(const obs_options *options,
obs_get_bucket_dis_policy_handler *handler, void *callback_data); 请求参数说明
| 参数名称 | 参数类型 | 是否必选 | 描述 |
|---|---|---|---|
| options | const obs_options* | 必选 | 参数解释: 请求桶的上下文,通过obs_options设置AK、SK、endpoint、bucket、超时时间、临时鉴权。 约束限制: 无 取值范围: 无 默认取值: 无 |
| handler | 必选 | 参数解释: 回调结构体,结构体内所有成员都是回调函数的指针,用于设置处理接口响应数据的回调函数。 约束限制: 无 取值范围: 无 默认取值: 无 | |
| callback_data | void * | 可选 | 参数解释: 用户自定义回调数据。 约束限制: 无 取值范围: 无 默认取值: 无 |
| 参数名称 | 参数类型 | 是否必选 | 描述 |
|---|---|---|---|
| response_handler | 必选 | 参数解释: 响应回调函数结构体。 约束限制: 无 取值范围: 无 默认取值: 无 | |
| get_bucket_dis_policy_callback | 必选 | 参数解释: DIS通知策略回调函数指针,可以在这个回调中把dis_policy_rules的内容记录到callback_data中。 约束限制: 无 取值范围: 无 默认取值: 无 |
| 参数名称 | 参数类型 | 是否必选 | 描述 |
|---|---|---|---|
| dis_policy_rules_return | 表4* | 必选 | 参数解释: DIS通知策略规则数组,包含id、stream、events等信息。 约束限制: 该结构体及其中指针指向的内存在回调返回后会被SDK释放,如需保留请自行复制。 取值范围: 无 默认取值: 无 |
| rule_number | unsigned int | 必选 | 参数解释: 返回的DIS通知策略规则数量。 约束限制: 无 取值范围: 无 默认取值: 无 |
| callback_data | void * | 必选 | 参数解释: 用户自定义回调数据指针。 约束限制: 无 取值范围: 无 默认取值: 无 |
| 参数名称 | 参数类型 | 是否必选 | 描述 |
|---|---|---|---|
| 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 * | 可选 | 参数解释: 对象名后缀过滤规则,仅对匹配该后缀的对象生效。 约束限制: 无 取值范围: 无 默认取值: 无 |
代码示例
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 | #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); obs_status get_dis_policy_callback(obs_dis_policy_rule *dis_policy_rules_return, unsigned int rule_number, void *callback_data); typedef struct DisPolicyInfo { obs_status ret_status; } DisPolicyInfo; int main() { obs_initialize(OBS_INIT_ALL); obs_options options; init_obs_options(&options); // host_name填写桶所在的endpoint, 此处以中国-香港为例,其他地区请按实际情况填写。 options.bucket_options.host_name = "obs.ap-southeast-1.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_response_handler response_handler = {&response_properties_callback, &response_complete_callback}; obs_get_bucket_dis_policy_handler get_dis_policy_handler = { response_handler, &get_dis_policy_callback }; DisPolicyInfo dis_policy_info = {0}; dis_policy_info.ret_status = OBS_STATUS_BUTT; // 获取桶DIS通知策略 get_bucket_dis_policy(&options, &get_dis_policy_handler, &dis_policy_info); if (OBS_STATUS_OK == dis_policy_info.ret_status) { printf("get bucket dis policy successfully.\n"); } else { printf("get bucket dis policy failed(%s).\n", obs_get_status_name(dis_policy_info.ret_status)); } obs_deinitialize(); } obs_status get_dis_policy_callback(obs_dis_policy_rule *dis_policy_rules_return, unsigned int rule_number, void *callback_data) { if (dis_policy_rules_return) { unsigned int i; for (i = 0; i < rule_number; i++) { printf("rule[%u] id: %s\n", i, dis_policy_rules_return[i].id ? dis_policy_rules_return[i].id : ""); printf("rule[%u] stream: %s\n", i, dis_policy_rules_return[i].stream ? dis_policy_rules_return[i].stream : ""); printf("rule[%u] events_number: %u\n", i, dis_policy_rules_return[i].events_number); } } return OBS_STATUS_OK; } 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) { ((DisPolicyInfo*)callback_data)->ret_status = status; } if (error && error->message) { printf("Error: %s\n", error->message); } } |