更新时间：2026-07-13 GMT+08:00
获取桶公共状态(C SDK)
开发过程中，您有任何问题可以在GitHub上提交issue，或者在华为云对象存储服务论坛中发帖求助。
功能介绍
调用获取桶公共状态接口，您可以查询指定桶是否为公开状态。桶的公共状态综合考虑了桶策略、ACL和阻止公共访问配置等多个维度的信息，用于判断桶是否存在公共访问风险。
接口约束
- 您必须是桶拥有者或拥有获取桶公共状态的权限，才能获取桶公共状态。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:GetBucketPublicStatus权限，如果使用桶策略则需授予GetBucketPublicStatus权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、自定义创建桶策略。
- OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。
方法定义
void get_bucket_public_status(const obs_options *options,
obs_get_bucket_public_status_handler *handler, void *callback_data); 请求参数说明
| 参数名称 | 参数类型 | 是否必选 | 描述 |
|---|---|---|---|
| options | const obs_options* | 必选 | 参数解释： 请求桶的上下文，通过obs_options设置AK、SK、endpoint、bucket、超时时间、临时鉴权。 约束限制： 无 取值范围： 无 默认取值： 无 |
| handler | 必选 | 参数解释： 回调结构体，包含响应回调、结束回调和获取桶公共状态的回调。 约束限制： 无 取值范围： 无 默认取值： 无 | |
| callback_data | void * | 可选 | 参数解释： 用户自定义回调数据。 约束限制： 无 取值范围： 无 默认取值： 无 |
| 参数名称 | 参数类型 | 是否必选 | 描述 |
|---|---|---|---|
| response_handler | 必选 | 参数解释： 响应回调函数结构体。 约束限 取值范围： 无 默认取值： 无 制： 无 | |
| get_public_status_callback | 必选 | 参数解释： 获取桶公共状态的回调函数指针，在该回调中可以读取obs_bucket_public_status的内容。 约束限制： 无 取值范围： 无 默认取值： 无 |
| 参数名称 | 参数类型 | 是否必选 | 描述 |
|---|---|---|---|
| policy_status | const 表3 obs_bucket_public_status* | 必选 | 参数解释： 桶公共状态结构体，包含桶是否公开的信息。 约束限制： 该结构体及其中指针指向的内存在回调返回后会被SDK释放，如需保留请自行复制。 取值范围： 无 默认取值： 无 |
| callback_data | void * | 必选 | 参数解释： 用户自定义回调数据指针。 约束限制： 无 取值范围： 无 默认取值： 无 |
代码示例
以下示例展示如何获取桶公共状态。
#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 PublicStatusResult
{
bool is_public;
obs_status ret_status;
} PublicStatusResult;
obs_status get_public_status_callback(const obs_bucket_public_status *public_status, void *callback_data)
{
PublicStatusResult *result = (PublicStatusResult *)callback_data;
if (public_status) {
result->is_public = public_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_public_status_handler handler = {0};
handler.response_handler.properties_callback = &response_properties_callback;
handler.response_handler.complete_callback = &response_complete_callback;
handler.get_public_status_callback = &get_public_status_callback;
PublicStatusResult result;
memset(&result, 0, sizeof(PublicStatusResult));
result.ret_status = OBS_STATUS_BUTT;
get_bucket_public_status(&options, &handler, &result);
if (OBS_STATUS_OK == result.ret_status) {
printf("get bucket public status successfully.\n");
printf("is_public: %s\n", result.is_public ? "true" : "false");
} else {
printf("get bucket 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) {
PublicStatusResult *result = (PublicStatusResult *)callback_data;
result->ret_status = status;
}
if (error && error->message) { printf("Error: %s\n", error->message); }
} 父主题： 阻止桶公共访问(C SDK)
