更新时间:2026-07-13 GMT+08:00
分享

获取桶元数据(C SDK)

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

功能介绍

调用获取桶元数据接口,可获取指定桶的相关信息,包括指定桶的存储类型、区域位置、跨域资源共享(CORS)规则、冗余策略等信息。

接口约束

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

方法定义

void obs_head_bucket(const obs_options *options, obs_response_handler *handler, 
                    void *callback_data);

请求参数说明

表1 请求参数列表

参数名称

参数类型

是否必选

描述

options

const obs_options*

必选

参数解释:

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

约束限制:

handler

obs_response_handler *

必选

参数解释:

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

约束限制:

callback_data

void *

可选

参数解释:

用户自定义回调数据。

约束限制:

取值范围:

默认取值:

代码示例

以下示例展示如何获取桶的元数据信息。
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
#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);
typedef struct BucketMetadata
{
    char bucket_location[256];
    char storage_class[64];
    char obs_version[64];
    char obs_head_epid[256];
    obs_status ret_status;
} BucketMetadata;
int main()
{
    // 以下示例展示如何通过obs_head_bucket获取桶元数据:
    // 在程序入口调用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 * bucketName = "example-bucket-name";
    options.bucket_options.bucket_name = bucketName;
    obs_response_handler response_handler = { &response_properties_callback, &response_complete_callback };
    // 创建回调数据
    BucketMetadata metadata;
    memset(&metadata, 0, sizeof(BucketMetadata));
    metadata.ret_status = OBS_STATUS_BUTT;
    // 获取桶元数据
    obs_head_bucket(&options, &response_handler, &metadata);
    if (OBS_STATUS_OK == metadata.ret_status) {
        printf("get bucket metadata successfully.\n");
        printf("bucket_location: %s\n", metadata.bucket_location);
        printf("storage_class: %s\n", metadata.storage_class);
        printf("obs_version: %s\n", metadata.obs_version);
        printf("obs_head_epid: %s\n", metadata.obs_head_epid);
    }
    else
    {
        printf("get bucket metadata failed(%s).\n", obs_get_status_name(metadata.ret_status));
    }
    // 释放分配的全局资源
    obs_deinitialize();
}
obs_status response_properties_callback(const obs_response_properties *properties, void *callback_data)
{
    BucketMetadata *metadata = (BucketMetadata *)callback_data;
    if (properties == NULL)
    {
        return OBS_STATUS_OK;
    }
    // 将桶元数据记录到callback_data中
    if (properties->bucket_location) {
        strncpy(metadata->bucket_location, properties->bucket_location, sizeof(metadata->bucket_location) - 1);
    }
    if (properties->storage_class) {
        strncpy(metadata->storage_class, properties->storage_class, sizeof(metadata->storage_class) - 1);
    }
    if (properties->obs_version) {
        strncpy(metadata->obs_version, properties->obs_version, sizeof(metadata->obs_version) - 1);
    }
    if (properties->obs_head_epid) {
        strncpy(metadata->obs_head_epid, properties->obs_head_epid, sizeof(metadata->obs_head_epid) - 1);
    }
    return OBS_STATUS_OK;
}
void response_complete_callback(obs_status status, const obs_error_details *error, void *callback_data)
{
    if (callback_data) {
        BucketMetadata *metadata = (BucketMetadata *)callback_data;
        metadata->ret_status = status;
    }
    if (error && error->message) {
        printf("Error: %s\n", error->message);
    }
}

相关链接

相关文档