# 获取桶公共状态(C SDK)
![](https://support.huaweicloud.com/sdk-c-devg-obs/public_sys-resources/notice_3.0-zh-cn.png)
开发过程中，您有任何问题可以在GitHub上[提交issue](https://github.com/huaweicloud/huaweicloud-sdk-c-obs/issues)，或者在[华为云对象存储服务论坛](https://bbs.huaweicloud.com/forum/forum-620-1.html)中发帖求助。
#### 功能说明
调用获取桶公共状态接口，您可以查询指定桶是否为公开状态。桶的公共状态综合考虑了桶策略、ACL和阻止公共访问配置等多个维度的信息，用于判断桶是否存在公共访问风险。
#### 接口约束
- 您必须是桶拥有者或拥有获取桶公共状态的权限，才能获取桶公共状态。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:GetBucketPublicStatus权限，如果使用桶策略则需授予GetBucketPublicStatus权限。相关授权方式介绍可参见[OBS权限控制概述](https://support.huaweicloud.com/perms-cfg-obs/obs_40_0001.html)，配置方式详见[使用IAM自定义策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0121.html)、[自定义创建桶策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0123.html)。
- OBS支持的Region与Endpoint的对应关系，详细信息请参见[地区与终端节点](https://console.huaweicloud.com/apiexplorer/#/endpoint/OBS)。
 
#### 方法定义
```
void get_bucket_public_status(const obs_options *options,
    obs_get_bucket_public_status_handler *handler, void *callback_data);
```
#### 请求参数说明
表1请求参数列表 
| 参数名称          | 参数类型                                                                                                                | 是否必选 | 描述                                                                                                                                                                                                                                                                                                                                                                                      |
|:---|:---|:---|:---|
| options       | const [obs_options](https://support.huaweicloud.com/sdk-c-devg-obs/obs_20_0085.html#obs_20_0085__table9681927859)\* | 必选   | **参数解释：** 请求桶的上下文，通过obs_options设置AK、SK、endpoint、bucket、超时时间、临时鉴权。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 |
| handler       | [表2 obs_get_bucket_public_status_handler]\*                                         | 必选   | **参数解释：** 回调结构体，包含响应回调、结束回调和获取桶公共状态的回调。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无                                                                                         |
| callback_data | void \*                                                                                                             | 可选   | **参数解释：** 用户自定义回调数据。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无                                                                                                                        |
   
 表2obs_get_bucket_public_status_handler 
| 参数名称                       | 参数类型                                                                                                               | 是否必选 | 描述                                                                                                                                                                                                                                                                                                              |
|:---|:---|:---|:---|
| response_handler           | [obs_response_handler](https://support.huaweicloud.com/sdk-c-devg-obs/obs_20_0087.html#obs_20_0087__table53755070) | 必选   | **参数解释：** 响应回调函数结构体。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无                                        |
| get_public_status_callback | [obs_get_bucket_public_status_callback]\*                                        | 必选   | **参数解释：** 获取桶公共状态的回调函数指针，在该回调中可以读取obs_bucket_public_status的内容。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 |
   
 表3obs_get_bucket_public_status_callback 
| 参数名称          | 参数类型                                                                  | 是否必选 | 描述                                                                                                                                                                                                                                                                                                                      |
|:---|:---|:---|:---|
| policy_status | const [表3 obs_bucket_public_status]\* | 必选   | **参数解释：** 桶公共状态结构体，包含桶是否公开的信息。 **约束限制：** 该结构体及其中指针指向的内存在回调返回后会被SDK释放，如需保留请自行复制。 **取值范围：** 无 **默认取值：** 无 |
| callback_data | void \*                                                               | 必选   | **参数解释：** 用户自定义回调数据指针。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无                                                    |
   
 表4obs_bucket_public_status 
| 参数名称      | 参数类型 | 描述                                                                                                                                                                                                                                                                                                                                                                                                               |
|:---|:---|:---|
| is_public | bool | **参数解释：** 桶是否公开。 **约束限制：** 无 **取值范围：** - true：公开  - false：非公开   **默认取值：** false |
   
#### 代码示例
以下示例展示如何获取桶公共状态。
```
#include "eSDKOBS.h"
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
// 响应回调函数，可以在这个回调中把properties的内容记录到callback_data(用户自定义回调数据)中
obs_status response_properties_callback(const obs_response_properties *properties, void *callback_data);
// 结束回调函数，可以在这个回调中把obs_status和obs_error_details的内容记录到callback_data(用户自定义回调数据)中
void response_complete_callback(obs_status status, const obs_error_details *error, void *callback_data);
// 获取桶公共状态的数据回调函数
obs_status get_public_status_callback(const obs_bucket_public_status *public_status, void *callback_data);
// 自定义回调数据：用于在回调间传递结果状态和公共状态
typedef struct PublicStatusResult
{
    bool is_public;
    obs_status ret_status;
} PublicStatusResult;
int main()
{
    // 以下示例展示如何获取桶公共状态：
    // 在程序入口调用obs_initialize方法来初始化网络、内存等全局资源。
    obs_status ret_status = obs_initialize(OBS_INIT_ALL);
    if (OBS_STATUS_OK != ret_status)
    {
        printf("obs_initialize failed(%s).\n", obs_get_status_name(ret_status));
        return -1;
    }
    obs_options options;
    // 创建并初始化options，该参数包括访问域名(host_name)、访问密钥（access_key_id和access_key_secret）、桶名(bucket_name)、桶存储类别(storage_class)等配置信息
    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");
    // 填写Bucket名称，例如example-bucket-name。
    char * bucket_name = "example-bucket-name";
    options.bucket_options.bucket_name = bucket_name;
    // 设置回调函数
    obs_get_bucket_public_status_handler handler;
    memset(&handler, 0, sizeof(obs_get_bucket_public_status_handler));
    handler.response_handler.properties_callback = &response_properties_callback;
    handler.response_handler.complete_callback = &response_complete_callback;
    handler.get_bucket_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 get_public_status_callback(const obs_bucket_public_status *public_status, void *callback_data)
{
    PublicStatusResult *result = (PublicStatusResult *)callback_data;
    if (result && public_status) {
        result->is_public = public_status->is_public;
    }
    return OBS_STATUS_OK;
}
// 响应回调函数，可以在这个回调中把properties的内容记录到callback_data(用户自定义回调数据)中
obs_status response_properties_callback(const obs_response_properties *properties, void *callback_data)
{
    if (properties == NULL)
    {
        printf("error! obs_response_properties is null!");
        return OBS_STATUS_OK;
    }
// 打印响应信息
#define print_nonnull(name, field)                                 \
    do {                                                           \
        if (properties-> field) {                                  \
            printf("%s: %s\n", name, properties->field);          \
        }                                                          \
    } while (0)
    print_nonnull("request_id", request_id);
    print_nonnull("request_id2", request_id2);
    print_nonnull("content_type", content_type);
    if (properties->content_length) {
        printf("content_length: %llu\n", properties->content_length);
    }
    print_nonnull("server", server);
    print_nonnull("ETag", etag);
    print_nonnull("expiration", expiration);
    print_nonnull("website_redirect_location", website_redirect_location);
    print_nonnull("version_id", version_id);
    print_nonnull("allow_origin", allow_origin);
    print_nonnull("allow_headers", allow_headers);
    print_nonnull("max_age", max_age);
    print_nonnull("allow_methods", allow_methods);
    print_nonnull("expose_headers", expose_headers);
    print_nonnull("storage_class", storage_class);
    print_nonnull("server_side_encryption", server_side_encryption);
    print_nonnull("kms_key_id", kms_key_id);
    print_nonnull("customer_algorithm", customer_algorithm);
    print_nonnull("customer_key_md5", customer_key_md5);
    print_nonnull("bucket_location", bucket_location);
    print_nonnull("obs_version", obs_version);
    print_nonnull("restore", restore);
    print_nonnull("obs_object_type", obs_object_type);
    print_nonnull("obs_next_append_position", obs_next_append_position);
    print_nonnull("obs_head_epid", obs_head_epid);
    print_nonnull("reserved_indicator", reserved_indicator);
    int i;
    for (i = 0; i < properties->meta_data_count; i++) {
        printf("x-obs-meta-%s: %s\n", properties->meta_data[i].name,
            properties->meta_data[i].value);
    }
    return OBS_STATUS_OK;
}
// 结束回调函数，可以在这个回调中把obs_status和obs_error_details的内容记录到callback_data(用户自定义回调数据)中
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;
    } else {
        printf("Callback_data is NULL");
    }
    if (error && error->message) {
        printf("Error Message: \n   %s\n", error->message);
    }
    if (error && error->resource) {
        printf("Error Resource: \n  %s\n", error->resource);
    }
    if (error && error->further_details) {
        printf("Error further_details: \n   %s\n", error->further_details);
    }
    if (error && error->extra_details_count) {
        int i;
        for (i = 0; i < error->extra_details_count; i++) {
            printf("Error Extra Detail(%d):\n   %s:%s\n", i, error->extra_details[i].name,
                   error->extra_details[i].value);
        }
    }
    if (error && error->error_headers_count) {
        int i;
        for (i = 0; i < error->error_headers_count; i++) {
            const char *errorHeader = error->error_headers[i];
            printf("Error Headers(%d):\n    %s\n", i, errorHeader == NULL ? "NULL Header" : errorHeader);
        }
    }
}
```
#### 相关链接
- 关于获取桶公共状态的API说明，请参见[获取桶公共状态](https://support.huaweicloud.com/api-obs/obs_04_0177.html)。

- 获取桶公共状态过程中返回的错误码含义、问题原因及处理措施可参考[OBS错误码](https://support.huaweicloud.com/api-obs/obs_04_0115.html#section1)。