文档首页/ 对象存储服务 OBS/ SDK参考/ C/ 桶相关接口(C SDK)/ 阻止桶公共访问(C SDK)/ 获取桶级阻止公共访问配置(C SDK)
更新时间：2026-07-13 GMT+08:00
查看PDF
分享

获取桶级阻止公共访问配置(C SDK)

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

功能介绍

可通过本接口获取桶级BPA配置的相关信息。

接口约束

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

方法定义

void get_bucket_public_access_block(const obs_options *options,
    obs_get_bucket_public_access_block_handler *handler, void *callback_data);

请求参数说明

表1 请求参数列表

参数名称

参数类型

是否必选

描述

options

const obs_options*

必选

参数解释：

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

约束限制：

无

取值范围：

无

默认取值：

无

handler

表2 obs_get_bucket_public_access_block_handler*

必选

参数解释：

回调结构体，包含响应回调、结束回调和获取阻止公共访问配置的回调。

约束限制：

无

取值范围：

无

默认取值：

无

callback_data

void *

可选

参数解释：

用户自定义回调数据。

约束限制：

无

取值范围：

无

默认取值：

无
表2 obs_get_bucket_public_access_block_handler

参数名称

参数类型

是否必选

描述

response_handler

obs_response_handler

必选

参数解释：

响应回调结构体，包含properties_callback和complete_callback。

约束限制：

无

取值范围：

无

默认取值：

无

get_bpa_callback

表3 obs_get_bucket_public_access_block_callback*

必选

参数解释：

获取阻止公共访问配置的回调函数指针，在该回调中可以读取obs_bucket_public_access_block的内容。

约束限制：

无

取值范围：

无

默认取值：

无
表3 obs_get_bucket_public_access_block_callback

参数名称

参数类型

是否必选

描述

public_access_block

const 表4 obs_bucket_public_access_block*

必选

参数解释：

桶级阻止公共访问配置结构体，包含四个保护开关的状态。

约束限制：

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

取值范围：

无

默认取值：

无

callback_data

void *

必选

参数解释：

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

约束限制：

无

取值范围：

无

默认取值：

无
表4 obs_bucket_public_access_block

参数名称

参数类型

描述

block_public_acls

bool

参数解释：

是否锁定公共ACL。当为true时，禁止对象上传和ACL修改API设置公共ACL。

约束限制：

无

取值范围：

  • true：启用
  • false：不启用

默认取值：

false

ignore_public_acls

bool

参数解释：

是否忽略公共ACL。当为true时，OBS进行权限检查时公共ACL不生效。

约束限制：

无

取值范围：

  • true：启用
  • false：不启用

默认取值：

false

block_public_policy

bool

参数解释：

是否锁定公共策略。当为true时，桶策略修改API禁止设置公共策略。

约束限制：

无

取值范围：

  • true：启用
  • false：不启用

默认取值：

false

restrict_public_buckets

bool

参数解释：

是否限制账号访问。当为true时，如果桶策略状态为公开，则只允许云服务账号和本账号访问。

约束限制：

无

取值范围：

  • 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 BpaResult
{
    obs_bucket_public_access_block bpa_config;
    obs_status ret_status;
} BpaResult;
obs_status get_bpa_callback(const obs_bucket_public_access_block *public_access_block, void *callback_data)
{
    BpaResult *result = (BpaResult *)callback_data;
    if (public_access_block) {
        result->bpa_config = *public_access_block;
    }
    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_public_access_block_handler handler = {0};
    handler.response_handler.properties_callback = &response_properties_callback;
    handler.response_handler.complete_callback = &response_complete_callback;
    handler.get_bpa_callback = &get_bpa_callback;
    BpaResult result;
    memset(&result, 0, sizeof(BpaResult));
    result.ret_status = OBS_STATUS_BUTT;
    get_bucket_public_access_block(&options, &handler, &result);
    if (OBS_STATUS_OK == result.ret_status) {
        printf("get bucket public access block successfully.\n");
        printf("block_public_acls: %s\n", result.bpa_config.block_public_acls ? "true" : "false");
        printf("ignore_public_acls: %s\n", result.bpa_config.ignore_public_acls ? "true" : "false");
        printf("block_public_policy: %s\n", result.bpa_config.block_public_policy ? "true" : "false");
        printf("restrict_public_buckets: %s\n", result.bpa_config.restrict_public_buckets ? "true" : "false");
    } else {
        printf("get bucket public access block 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) {
        BpaResult *result = (BpaResult *)callback_data;
        result->ret_status = status;
    }
    if (error && error->message) { printf("Error: %s\n", error->message); }
}

相关链接

  • 获取桶级阻止公共访问配置过程中返回的错误码含义、问题原因及处理措施可参考OBS错误码。

相关文档