更新时间:2026-04-28 GMT+08:00
分享

设置对象accesslabel(C SDK)

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

您可以通过函数set_access_label设置并行文件系统中对象的accesslabel。

同一并行文件系统目录最多512条access_label ,每条长度最大为52。

接口约束

  • 您必须是对象拥有者或拥有设置对象accesslabel的权限,才能调用本接口。建议使用IAM或桶策略进行授权,相关授权方式介绍可参见OBS权限控制概述,配置方式详见使用IAM自定义策略配置对象策略
  • OBS支持的Region与Endpoint的对应关系,详细信息请参见地区与终端节点
  • 仅支持并行文件系统的目录级别的设置,并行文件系统级和文件级均不支持。
  • 目前接口仅在并行文件系统支持,普通对象桶不支持,如何创建并行文件系统请参考创建并行文件系统

方法定义

1
2
3
void set_access_label(const obs_options *options,
	char* key, put_access_label_handler * handler,
	Access_label_data * dir_access_labels);

请求参数描述

表1 请求参数列表

字段名

类型

约束

说明

options

const obs_options *

必选

请求桶的上下文,配置option(C SDK),通过obs_options设置AK、SK、endpoint、bucket、超时时间、临时鉴权

key

char *

必选

并行文件系统中的目录名称。

handler

put_access_label_handler *

必选

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

dir_access_labels

Access_label_data*

必选

accesslabel相关数据

表2 Access_label_data

字段名

类型

约束

说明

labels

char[512][53]

set_access_label时必选

所有的accesslabel

labels_len

int

set_access_label时必选,get_access_label时sdk会设置

labels中的accesslabel数目

json_str

char*

可选

json格式的access_label

status

obs_status

由sdk返回

标识请求是否成功的状态码

代码示例

以下示例展示如何设置对象的accesslabel:
#include "eSDKOBS.h"
#include <stdio.h>
#include <errno.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 dir_access_label_response_complete_callback(obs_status status, const obs_error_details *error, void *callback_data);
// 数据回调,用于传输access_label
int put_dir_access_label_json_callback(int buffer_size, char *buffer, void *callback_data);
int main()
{
    // 以下示例展示如何通过函数set_access_label设置并行文件系统中目录对象的accesslabel:
    // 在程序入口调用obs_initialize方法来初始化网络、内存等全局资源。
    obs_initialize(OBS_INIT_ALL);
    obs_options options;
    // 创建并初始化options,该参数包括访问域名(host_name)、访问密钥(access_key_id和acces_key_secret)、桶名(bucket_name)、桶存储类别(storage_class)等配置信息
    init_obs_options(&options);
    // host_name填写桶所在的endpoint, 此处以华北-北京四为例,其他地区请按实际情况填写。
    options.bucket_options.host_name = "obs.cn-north-4.myhuaweicloud.com";
    // 填写Bucket名称,例如example-posix-bucket-name。
    char * bucketName = "example-posix-bucket-name";
    options.bucket_options.bucket_name = bucketName;
    char *key = "test_set_access_label_directory/";
    int access_labels_len = 0;
    Access_label_data dir_access_label_datas;
    obs_status status = init_access_label(&dir_access_label_datas);
    if (status != OBS_STATUS_OK) {
        printf("init_access_label failed in %s", __FUNCTION__);
        return;
    }
    int ret = snprintf(dir_access_label_datas.labels[access_labels_len++], MAX_LABEL_LENGTH, "%s", "testlabel1");
    if (ret < 0 || ret >= MAX_LABEL_LENGTH) {
        printf("String copy truncated or failed, length of ACCESS_LABEL should be less than %d\n", MAX_LABEL_LENGTH);
    }
    ret = snprintf(dir_access_label_datas.labels[access_labels_len++], MAX_LABEL_LENGTH, "%s", "testlabel2");
    if (ret < 0 || ret >= MAX_LABEL_LENGTH) {
        printf("String copy truncated or failed, length of ACCESS_LABEL should be less than %d\n", MAX_LABEL_LENGTH);
    }
    ret = snprintf(dir_access_label_datas.labels[access_labels_len++], MAX_LABEL_LENGTH, "%s", "testlabel3");
    if (ret < 0 || ret >= MAX_LABEL_LENGTH) {
        printf("String copy truncated or failed, length of ACCESS_LABEL should be less than %d\n", MAX_LABEL_LENGTH);
    }
    ret = snprintf(dir_access_label_datas.labels[access_labels_len++], MAX_LABEL_LENGTH, "%s", "te01234567890123456789012345678901234567890123456789");
    if (ret < 0 || ret >= MAX_LABEL_LENGTH) {
        printf("String copy truncated or failed, length of ACCESS_LABEL should be less than %d\n", MAX_LABEL_LENGTH);
    }
    dir_access_label_datas.labels_len = access_labels_len;
    put_access_label_handler handler = {
        {
            response_properties_callback,
            dir_access_label_response_complete_callback
        },
        put_dir_access_label_json_callback
    };
    // 设置并行文件系统中目录对象的accesslabel
    set_access_label(&options, key, &handler, &dir_access_label_datas);
    // 判断请求是否成功
    if (dir_access_label_datas.status == OBS_STATUS_OK) {
        printf("set_access_label for bucket %s successfully. \n", bucketName);
    }
    else {
        printf("set_access_label for bucket %s failed(%s).\n", bucketName, obs_get_status_name(dir_access_label_datas.status));
    }
    // 释放分配的全局资源
    obs_deinitialize();
}
int put_dir_access_label_json_callback(int buffer_size, char *buffer, void *callback_data) {
    Access_label_data *data =
        (Access_label_data *)callback_data;
    int toRead = 0;
    if (data->json_str_remain_size > 0) {
        toRead = ((data->json_str_remain_size > (unsigned)buffer_size) ?
            (unsigned)buffer_size : data->json_str_remain_size);
        if (toRead > buffer_size) {
            printf("memcpy failed in put_dir_access_label_json_callback! toRead exceeds buffer_size.\n");
            // 注意:根据你的业务逻辑,这里通常需要 return 错误码或跳出当前流程
        } else {
            // 2. 检查通过后,使用标准跨平台的 memcpy 进行拷贝
            memcpy(buffer, data->json_str + data->json_current_offset, toRead);
        }
    }
    data->json_str_remain_size -= toRead;
    data->json_current_offset += toRead;
    return toRead;
}
// 响应回调函数,可以在这个回调中把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!");
        if (callback_data != NULL)
        {
            obs_sever_callback_data *data = (obs_sever_callback_data *)callback_data;
            printf("server_callback buf is %s, len is %llu",
                data->buffer, data->buffer_len);
            return OBS_STATUS_OK;
        }
        else {
            printf("error! obs_sever_callback_data 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 dir_access_label_response_complete_callback(obs_status status, const obs_error_details *error, void *callback_data)
{
    if (callback_data) {
        Access_label_data *dir_access_label_datas = (Access_label_data *)callback_data;
        dir_access_label_datas->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);
        }
    }
}
static void dir_access_label_response_complete_callback(obs_status status,
	const obs_error_details *error,
	void *callback_data) {
	if (callback_data)
	{
		Access_label_data *dir_access_label_datas = (Access_label_data *)callback_data;
		dir_access_label_datas->status = status;
	}
	else
	{
		statusG = status;
	}
	int len = 0;
	if (error && error->message) {
		printf("Error Message: \n	%s\n", error->message);
		len += snprintf_s(&(errorDetailsG[len]), sizeof(errorDetailsG) - len, _TRUNCATE,
			"  Message: %s\n", error->message);
	}
	if (error && error->resource) {
		printf("Error Resource: \n	%s\n", error->resource);
		len += snprintf_s(&(errorDetailsG[len]), sizeof(errorDetailsG) - len, _TRUNCATE,
			"  Resource: %s\n", error->resource);
	}
	if (error && error->further_details) {
		printf("Error further_details: \n	%s\n", error->further_details);
		len += snprintf_s(&(errorDetailsG[len]), sizeof(errorDetailsG) - len, _TRUNCATE,
			"  Further Details: %s\n", error->further_details);
	}
	if (error && error->extra_details_count) {
		len += snprintf_s(&(errorDetailsG[len]), sizeof(errorDetailsG) - len, _TRUNCATE,
			"%s", "  Extra Details:\n");
		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);
			len += snprintf_s(&(errorDetailsG[len]),
				sizeof(errorDetailsG) - len, _TRUNCATE, "    %s: %s\n",
				error->extra_details[i].name,
				error->extra_details[i].value);
		}
	}
	if (error && error->error_headers_count) {
		len += snprintf_s(&(errorHeadersG[len]), sizeof(errorHeadersG) - len, _TRUNCATE,
			"%s", "  Extra Details:\n");
		int i;
		for (i = 0; i < error->error_headers_count; i++) {
			char* errorHeader = error->error_headers[i];
			printf("Error Headers(%d):\n	%s\n", i,
				errorHeader == NULL ? "NULL Header" : errorHeader);
			len += snprintf_s(&(errorHeadersG[len]),
				sizeof(errorHeadersG) - len, _TRUNCATE, "    %s\n",
				errorHeader == NULL ? "NULL Header" : errorHeader);
		}
	}
}

int put_dir_access_label_json_callback(int buffer_size, char *buffer, void *callback_data) {

	Access_label_data *data =
		(Access_label_data *)callback_data;

	int toRead = 0;
	if (data->json_str_remain_size > 0) {
		toRead = ((data->json_str_remain_size > (unsigned)buffer_size) ?
			(unsigned)buffer_size : data->json_str_remain_size);
		errno_t ret = memcpy_s(buffer, buffer_size, data->json_str + data->json_current_offset, toRead);
		if (ret != EOK) {
			printf("memcpy_s failed in put_dir_access_label_json_callback!");
		}
	}

	data->json_str_remain_size -= toRead;
	data->json_current_offset += toRead;


	return toRead;
}

static void test_set_access_label(char *bucket_name, char *key) {
	obs_options option;
	init_obs_options(&option);
	obs_put_properties putProperties = { 0 };
	init_put_properties(&putProperties);

	option.bucket_options.host_name = HOST_NAME;
	option.bucket_options.bucket_name = bucket_name;
    // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险,建议在配置文件或者环境变量中密文存放,使用时解密,确保安全;本示例以ak和sk保存在环境变量中为例,运行本示例前请先在本地环境中设置环境变量ACCESS_KEY_ID和SECRET_ACCESS_KEY。
    // 您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
    option.bucket_options.access_key = getenv("ACCESS_KEY_ID");
    option.bucket_options.secret_access_key = getenv("SECRET_ACCESS_KEY");

	int access_labels_len = 0;
	Access_label_data dir_access_label_datas;
	obs_status status = init_access_label(&dir_access_label_datas);
	if (status != OBS_STATUS_OK) {
		printf("init_access_label failed in %s", __FUNCTION__);
		return;
	}

	errno_t ret = strcpy_s(dir_access_label_datas.labels[access_labels_len++], 53, "testlabel1");
	if (ret != EOK) {
		printf("strcpy_s failed, length of ACCESS_LABEL should be less than %d", MAX_LABEL_LENGTH);
	}
	ret = strcpy_s(dir_access_label_datas.labels[access_labels_len++], 53, "testlabel2");
	if (ret != EOK) {
		printf("strcpy_s failed, length of ACCESS_LABEL should be less than %d", MAX_LABEL_LENGTH);
	}
	ret = strcpy_s(dir_access_label_datas.labels[access_labels_len++], 53, "testlabel3");
	if (ret != EOK) {
		printf("strcpy_s failed, length of ACCESS_LABEL should be less than %d", MAX_LABEL_LENGTH);
	}
	ret = strcpy_s(dir_access_label_datas.labels[access_labels_len++], 53, "te01234567890123456789012345678901234567890123456789");
	if (ret != EOK) {
		printf("strcpy_s failed, length of ACCESS_LABEL should be less than %d", MAX_LABEL_LENGTH);
	}
	dir_access_label_datas.labels_len = access_labels_len;
	put_access_label_handler handler = {
		{
			response_properties_callback, // 您可以在sdk的源码的demo_windows.cpp 文件中找到这个函数示例 
			dir_access_label_response_complete_callback
		},
		put_dir_access_label_json_callback
	};
	set_access_label(&option, key, &handler, &dir_access_label_datas);
	printf("test_set_access_label's obs_status is %s", obs_get_status_name(dir_access_label_datas.status));
}

相关链接

  • 关于设置对象accesslabel的API说明,请参见API文档。
  • 设置对象accesslabel中返回的错误码含义、问题原因及处理措施可参考OBS错误码

相关文档