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

获取桶策略(C SDK)

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

功能介绍

调用获取桶策略接口，您可以获取指定桶的桶策略。

接口约束

  • 您必须是桶拥有者或拥有获取桶策略的权限，才能调用本接口。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:GetBucketPolicy权限，如果使用桶策略则需授予GetBucketPolicy权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、自定义创建桶策略。
  • OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。
  • 如果桶未配置策略，接口将返回OBS_STATUS_NoSuchBucketPolicy错误。

方法定义

void get_bucket_policy(const obs_options *options, int policy_return_size,
                      char *policy_return, obs_response_handler *handler,
                      void *callback_data);

请求参数说明

表1 请求参数列表

参数名称

参数类型

是否必选

描述

options

const obs_options*

必选

参数解释：

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

约束限制：

无

取值范围：

无

默认取值：

无

policy_return_size

int

必选

参数解释：

用于存储策略内容的缓冲区大小，单位为字节。

约束限制：

需大于等于实际策略内容长度（含结束符），否则策略内容将被截断。建议缓冲区大小不小于21KB，以容纳最大策略内容。

取值范围：

正整数。

默认取值：

无

policy_return

char *

必选

参数解释：

用于存储返回的策略内容的缓冲区。

约束限制：

该缓冲区由调用方分配和释放，需确保缓冲区大小不小于policy_return_size指定的值。

取值范围：

无

默认取值：

无

handler

obs_response_handler *

必选

参数解释：

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

约束限制：

无

取值范围：

无

默认取值：

无

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);
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和secret_access_key）、桶名(bucket_name)等配置信息
    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");
    if (!options.bucket_options.access_key || !options.bucket_options.secret_access_key) {
        printf("ERROR: ACCESS_KEY_ID and SECRET_ACCESS_KEY environment variables must be set.\n");
        obs_deinitialize();
        return -1;
    }
    // 填写Bucket名称，例如example-bucket-name。
    options.bucket_options.bucket_name = "example-bucket-name";
    // 设置响应回调函数
    obs_response_handler response_handler =
    {
        &response_properties_callback,
        &response_complete_callback
    };
    // 分配策略内容缓冲区，建议不小于21KB
    #define MAX_POLICY_BUFFER_SIZE (21 * 1024)
    char policy[MAX_POLICY_BUFFER_SIZE] = {0};
    ret_status = OBS_STATUS_BUTT;
    get_bucket_policy(&options, sizeof(policy), policy, &response_handler, &ret_status);
    if (OBS_STATUS_OK == ret_status) {
        printf("get bucket policy successfully.\npolicy:\n%s\n", policy);
    } else {
        printf("get bucket policy failed(%s).\n", obs_get_status_name(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) { *(obs_status*)callback_data = status; }
    if (error && error->message) { printf("Error: %s\n", error->message); }
}

相关链接

父主题： 桶策略(C SDK)

相关文档