设置对象标签(C SDK)
开发过程中,您有任何问题可以在GitHub上提交issue,或者在华为云对象存储服务论坛中发帖求助。
功能说明
用户可以通过本接口设置或更新对象(Object)的标签信息。对象标签使用一组键值对(Key-Value)标记对象。
接口约束
- 您必须是对象拥有者或拥有设置对象标签的权限,才能设置对象标签。建议使用IAM或桶策略进行授权,如果使用IAM则需授予obs:object:PutObjectTagging权限,如果使用桶策略则需授予PutObjectTagging权限。相关授权方式介绍可参见OBS权限控制概述,配置方式详见使用IAM自定义策略、自定义创建桶策略。
- OBS支持的Region与Endpoint的对应关系,详细信息请参见地区与终端节点。
- 每个桶最多能设置10个标签。
- 并行文件系统不支持给文件设置标签。
- 标签的键名(Key)的最大长度为128个字符,标签的键值(Value)的最大长度为255个字符。
- 标签的键名(Key)和键值(Value)不能包含字符“,”、“*”、“|”、“/”、“<”、“>”、“=”、“\”以及ASCII码0x00--0x1F这些控制字符。
方法定义
void set_object_tagging(const obs_options *options, const char *key,
obs_name_value *tagging_list, unsigned int number,
obs_response_handler *handler, void *callback_data); 请求参数说明
| 参数名称 | 参数类型 | 是否必选 | 描述 |
|---|---|---|---|
| options | const obs_options* | 必选 | 参数解释: 请求桶的上下文,通过obs_options设置AK、SK、endpoint、bucket、超时时间、临时鉴权。 约束限制: 无 取值范围: 无 默认取值: 无 |
| key | char * | 必选 | 参数解释: 对象名。对象名是对象在桶中的完整路径,路径中不包含桶名。 例如,您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中,对象名为folder/test.txt。 约束限制: 同一个桶中存储的对象名必须是唯一的。 取值范围: 长度大于0且不超过1024的字符串。 默认取值: 无 |
| tagging_list | 必选 | 参数解释: 标签列表。 约束限制: 无 取值范围: 无 默认取值: 无 | |
| number | unsigned int | 必选 | 参数解释: 标签个数。 约束限制: 无 取值范围: [0, 10] 默认取值: 无 |
| handler | 必选 | 参数解释: 回调结构体,结构体内所有成员都是回调函数的指针,用于设置处理接口响应数据的回调函数。您可以通过设置回调函数,把服务端的响应数据复制到您的自定义回调数据callback_data中。 约束限制: 无 取值范围: 无 默认取值: 无 | |
| callback_data | void * | 可选 | 参数解释: 用户自定义回调数据。 约束限制: 无 取值范围: 无 默认取值: 无 |
| 参数名称 | 参数类型 | 是否必选 | 描述 |
|---|---|---|---|
| name | char * | 作为请求参数时必选 | 参数解释: 标签的键。 约束限制:
默认取值: 无 取值范围: 无 默认取值: 无 |
| value | char * | 作为请求参数时必选 | 参数解释: 标签的值。 约束限制: 标签的值可以重复,并且可以为空。
默认取值: 无 取值范围: 无 默认取值: 无 |
代码示例:
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 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 | #include "eSDKOBS.h" #include <stdio.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); #define TAG_LIST_LENGTH 10 int main() { // 以下示例展示如何通过set_object_tagging设置对象标签: // 在程序入口调用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_status ret_status = OBS_STATUS_BUTT; // 定义对象标签 char tagKey[][OBS_COMMON_LEN_256] = { {"k1"},{"k2"},{"k3"},{"k4"},{"k5"},{"k6"},{"k7"},{"k8"},{"k9"},{"k10"} }; char tagValue[][OBS_COMMON_LEN_256] = { {"v1"},{"v2"},{"v3"},{"v4"},{"v5"},{"v6"},{"v7"},{"v8"},{"v9"},{"v10"} }; obs_name_value tagginglist[TAG_LIST_LENGTH] = { 0 }; int i = 0; for (; i < TAG_LIST_LENGTH; i++) { tagginglist[i].name = tagKey[i]; tagginglist[i].value = tagValue[i]; } // 设置对象标签 set_object_tagging(&options, "objectname", tagginglist, TAG_LIST_LENGTH, &response_handler, &ret_status); if (OBS_STATUS_OK == ret_status) { printf("set object tagging successfully. \n"); } else { printf("set object tagging failed(%s).\n", obs_get_status_name(ret_status)); } // 释放分配的全局资源 obs_deinitialize(); } // 响应回调函数,可以在这个回调中把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) { obs_status *ret_status = (obs_status *)callback_data; *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); } } } |