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

获取桶归档存储对象直读策略(C SDK)

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

功能介绍

桶的所有者可以获取指定桶的归档存储对象直读状态。

如果从未设置桶的归档存储对象直读状态,或者已经删除桶的归档存储对象直读状态,则此操作不会返回桶的归档存储对象直读状态。

接口约束

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

方法定义

void get_bucket_direct_cold_access(const obs_options *options,
    obs_get_bucket_direct_cold_access_handler *handler, void *callback_data);

请求参数说明

表1 请求参数列表

参数名称

参数类型

是否必选

描述

options

const obs_options*

必选

参数解释:

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

约束限制:

取值范围:

默认取值:

handler

obs_get_bucket_direct_cold_access_handler *

必选

参数解释:

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

约束限制:

取值范围:

默认取值:

callback_data

void *

可选

参数解释:

用户自定义回调数据。

约束限制:

取值范围:

默认取值:

表2 obs_get_bucket_direct_cold_access_handler

参数名称

参数类型

是否必选

描述

response_handler

obs_response_handler

必选

参数解释:

响应回调函数结构体。

约束限制:

取值范围:

默认取值:

get_bucket_direct_cold_access_callback

表3 obs_get_bucket_direct_cold_access_callback*

必选

参数解释:

归档直读策略回调函数指针,可以在这个回调中把direct_cold_access_status的内容记录到callback_data(用户自定义回调数据)中。

约束限制:

取值范围:

默认取值:

表3 obs_get_bucket_direct_cold_access_callback

参数名称

参数类型

是否必选

描述

direct_cold_access_status

const char *

必选

参数解释:

归档直读策略的状态。

约束限制:

取值范围:

Enabled:归档直读策略已启用。

Disabled:归档直读策略已关闭

空字符串:桶未配置归档直读策略。

默认取值:

callback_data

void *

必选

参数解释:

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

约束限制:

取值范围:

默认取值

代码示例

以下示例展示如何获取桶归档直读策略。
#include "eSDKOBS.h"
#include <stdio.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_direct_cold_access_callback(const char *enabled, void *callback_data);
typedef struct DirectColdAccessInfo
{
    char enabled[64];
    obs_status ret_status;
}DirectColdAccessInfo;
int main()
{
    // 以下示例展示如何通过get_bucket_direct_cold_access获取桶归档直读策略:
    // 在程序入口调用obs_initialize方法来初始化网络、内存等全局资源。
    obs_initialize(OBS_INIT_ALL);
    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 * bucketName = "example-bucket-name";
    options.bucket_options.bucket_name = bucketName;
    obs_response_handler response_handler = { &response_properties_callback, &response_complete_callback };
    // 设置响应回调函数
    obs_get_bucket_direct_cold_access_handler get_direct_cold_access_handler =
    {
        response_handler,
        &get_direct_cold_access_callback
    };
    // 创建回调数据
    DirectColdAccessInfo direct_cold_access_info;
    memset(&direct_cold_access_info, 0, sizeof(DirectColdAccessInfo));
    direct_cold_access_info.ret_status = OBS_STATUS_BUTT;
    // 获取桶归档直读策略
    get_bucket_direct_cold_access(&options, &get_direct_cold_access_handler, &direct_cold_access_info);
    if (OBS_STATUS_OK == direct_cold_access_info.ret_status) {
        printf("get bucket direct cold access successfully. enabled: %s\n", direct_cold_access_info.enabled);
    }
    else
    {
        printf("get bucket direct cold access failed(%s).\n", obs_get_status_name(direct_cold_access_info.ret_status));
    }
    // 释放分配的全局资源
    obs_deinitialize();
}
obs_status get_direct_cold_access_callback(const char *enabled, void *callback_data)
{
    DirectColdAccessInfo *info = (DirectColdAccessInfo *)callback_data;
    if (enabled) {
        strncpy(info->enabled, enabled, sizeof(info->enabled) - 1);
        info->enabled[sizeof(info->enabled) - 1] = '\0';
    } else {
        info->enabled[0] = '\0';
    }
    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("version_id", version_id);
    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) {
        DirectColdAccessInfo *info = (DirectColdAccessInfo *)callback_data;
        info->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);
        }
    }
}

相关链接

相关文档