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

获取桶策略公共状态(C SDK)

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

功能介绍

调用获取桶策略公共状态接口,您可以查询指定桶的桶策略是否为公开状态。

接口约束

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

方法定义

void get_bucket_policy_public_status(const obs_options *options,
    obs_get_bucket_policy_public_status_handler *handler, void *callback_data);

请求参数说明

表1 请求参数列表

参数名称

参数类型

是否必选

描述

options

const obs_options*

必选

参数解释:

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

约束限制:

handler

表2 *

必选

参数解释:

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

约束限制:

callback_data

void *

可选

参数解释:

用户自定义回调数据。

约束限制:

取值范围:

默认取值:

表2 obs_get_bucket_policy_public_status_handler

参数名称

参数类型

是否必选

描述

response_handler

obs_response_handler

必选

参数解释:

响应回调函数结构体。

约束限制:

get_policy_status_callback

表3 obs_get_bucket_policy_public_status_callback*

必选

参数解释:

获取桶策略公共状态的回调函数指针,在该回调中可以读取obs_bucket_policy_status的内容。

约束限制:

表3 obs_get_bucket_policy_public_status_callback

参数名称

参数类型

是否必选

描述

policy_status

const 表3 obs_bucket_public_status*

必选

参数解释:

桶策略公共状态结构体,包含桶策略是否公开的信息。

约束限制:

该结构体及其中指针指向的内存在回调返回后会被SDK释放,如需保留请自行复制。

callback_data

void *

必选

参数解释:

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

约束限制:

取值范围:

默认取值:

表4 obs_bucket_policy_status

参数名称

参数类型

描述

is_public

bool

参数解释:

桶策略是否公开。

约束限制:

取值范围:

true(公开)、false(非公开)。

默认取值:

false

代码示例

以下示例展示如何删除桶级阻止公共访问配置。
#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);
typedef struct PolicyStatusResult
{
    bool is_public;
    obs_status ret_status;
} PolicyStatusResult;
obs_status get_policy_status_callback(const obs_bucket_policy_status *policy_status, void *callback_data)
{
    PolicyStatusResult *result = (PolicyStatusResult *)callback_data;
    if (policy_status) {
        result->is_public = policy_status->is_public;
    }
    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_policy_public_status_handler handler = {0};
    handler.response_handler.properties_callback = &response_properties_callback;
    handler.response_handler.complete_callback = &response_complete_callback;
    handler.get_policy_status_callback = &get_policy_status_callback;
    PolicyStatusResult result;
    memset(&result, 0, sizeof(PolicyStatusResult));
    result.ret_status = OBS_STATUS_BUTT;
    get_bucket_policy_public_status(&options, &handler, &result);
    if (OBS_STATUS_OK == result.ret_status) {
        printf("get bucket policy public status successfully.\n");
        printf("is_public: %s\n", result.is_public ? "true" : "false");
    } else {
        printf("get bucket policy public status 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) {
        PolicyStatusResult *result = (PolicyStatusResult *)callback_data;
        result->ret_status = status;
    }
    if (error && error->message) { printf("Error: %s\n", error->message); }
}

相关链接

  • 获取桶策略公共状态过程中返回的错误码含义、问题原因及处理措施可参考OBS错误码

相关文档