简介
本文档提供关于存储桶复制的 API 概览以及 SDK 示例代码。
API | 操作名 | 操作描述 |
设置存储桶复制 | 设置存储桶的存储桶复制规则 | |
查询存储桶复制 | 查询存储桶的存储桶复制规则 | |
删除存储桶复制 | 删除存储桶的存储桶复制规则 |
设置存储桶复制
功能说明
设置指定存储桶的存储桶复制规则。
方法原型
cos_status_t *cos_put_bucket_replication(const cos_request_options_t *options,const cos_string_t *bucket,cos_replication_params_t *replication_param,cos_table_t **resp_headers);
参数说明
参数名称 | 参数描述 | 类型 |
options | COS 请求选项。 | Struct |
bucket | 存储桶名称,存储桶的命名格式为 BucketName-APPID,此处填写的存储桶名称必须为此格式 | String |
replication_param | 存储桶复制请求操作参数 | Struct |
role | 操作者账户信息 | String |
rule_list | 存储桶复制规则配置信息 | Struct |
id | 用来标注具体规则的名称 | String |
status | 标识规则是否生效,枚举值:Enabled,Disabled | String |
prefix | 匹配前缀。不可重叠,重叠返回错误 | String |
dst_bucket | 目标存储桶,资源标识符格式为: qcs::cos:[region]::[bucketname-AppId] | String |
storage_class | String | |
resp_headers | 返回 HTTP 响应消息的头域 | Struct |
返回结果说明
返回结果 | 描述 | 类型 |
code | 错误码 | Int |
error_code | 错误码内容 | String |
error_msg | 错误码描述 | String |
req_id | 请求消息 ID | String |
示例
#include "cos_http_io.h"#include "cos_api.h"#include "cos_log.h"#include <unistd.h>// endpoint 是 COS 访问域名信息,详情请参见 https://cloud.tencent.com/document/product/436/6224 文档static char TEST_COS_ENDPOINT[] = "cos.ap-guangzhou.myqcloud.com";// 开发者拥有的项目身份ID/密钥,可在 https://console.cloud.tencent.com/cam/capi 页面获取static char *TEST_ACCESS_KEY_ID; //your secret_idstatic char *TEST_ACCESS_KEY_SECRET; //your secret_key// 开发者访问 COS 服务时拥有的用户维度唯一资源标识,用以标识资源,可在 https://console.cloud.tencent.com/cam/capi 页面获取static char TEST_APPID[] = "<APPID>"; //your appid//the cos bucket name, syntax: [bucket]-[appid], for example: mybucket-1253666666,可在 https://console.cloud.tencent.com/cos5/bucket 查看static char TEST_BUCKET_NAME[] = "<bucketname-appid>";void log_status(cos_status_t *s){cos_warn_log("status->code: %d", s->code);if (s->error_code) cos_warn_log("status->error_code: %s", s->error_code);if (s->error_msg) cos_warn_log("status->error_msg: %s", s->error_msg);if (s->req_id) cos_warn_log("status->req_id: %s", s->req_id);}void init_test_config(cos_config_t *config, int is_cname){cos_str_set(&config->endpoint, TEST_COS_ENDPOINT);cos_str_set(&config->access_key_id, TEST_ACCESS_KEY_ID);cos_str_set(&config->access_key_secret, TEST_ACCESS_KEY_SECRET);cos_str_set(&config->appid, TEST_APPID);config->is_cname = is_cname;}void init_test_request_options(cos_request_options_t *options, int is_cname){options->config = cos_config_create(options->pool);init_test_config(options->config, is_cname);options->ctl = cos_http_controller_create(options->pool, 0);}void test_put_replication(){cos_pool_t *p = NULL;int is_cname = 0;cos_status_t *s = NULL;cos_request_options_t *options = NULL;cos_request_options_t *dst_options = NULL;cos_string_t bucket;cos_string_t dst_bucket;cos_table_t *resp_headers = NULL;cos_pool_create(&p, NULL);options = cos_request_options_create(p);init_test_request_options(options, is_cname);cos_str_set(&bucket, TEST_BUCKET_NAME);cos_str_set(&dst_bucket, "replicationtest");dst_options = cos_request_options_create(p);init_test_request_options(dst_options, is_cname);cos_str_set(&dst_options->config->endpoint, "cn-east.myqcloud.com");cos_replication_params_t *replication_param = NULL;replication_param = cos_create_replication_params(p);cos_str_set(&replication_param->role, "qcs::cam::uin/100000616666:uin/100000616666");cos_replication_rule_content_t *rule = NULL;rule = cos_create_replication_rule_content(p);cos_str_set(&rule->id, "Rule_01");cos_str_set(&rule->status, "Enabled");cos_str_set(&rule->prefix, "test1");cos_str_set(&rule->dst_bucket, "qcs:id/0:cos:cn-east:appid/1253686666:replicationtest");cos_list_add_tail(&rule->node, &replication_param->rule_list);rule = cos_create_replication_rule_content(p);cos_str_set(&rule->id, "Rule_02");cos_str_set(&rule->status, "Disabled");cos_str_set(&rule->prefix, "test2");cos_str_set(&rule->storage_class, "Standard_IA");cos_str_set(&rule->dst_bucket, "qcs:id/0:cos:cn-east:appid/1253686666:replicationtest");cos_list_add_tail(&rule->node, &replication_param->rule_list);rule = cos_create_replication_rule_content(p);cos_str_set(&rule->id, "Rule_03");cos_str_set(&rule->status, "Enabled");cos_str_set(&rule->prefix, "test3");cos_str_set(&rule->storage_class, "Standard_IA");cos_str_set(&rule->dst_bucket, "qcs:id/0:cos:cn-east:appid/1253686666:replicationtest");cos_list_add_tail(&rule->node, &replication_param->rule_list);//put bucket replications = cos_put_bucket_replication(options, &bucket, replication_param, &resp_headers);log_status(s);cos_pool_destroy(p);}int main(int argc, char *argv[]){// 通过环境变量获取 SECRETID 和 SECRETKEYTEST_ACCESS_KEY_ID = getenv("COS_SECRETID");TEST_ACCESS_KEY_SECRET = getenv("COS_SECRETKEY");if (cos_http_io_initialize(NULL, 0) != COSE_OK) {exit(1);}//set log level, default COS_LOG_WARNcos_log_set_level(COS_LOG_WARN);//set log output, default stderrcos_log_set_output(NULL);test_put_replication();cos_http_io_deinitialize();return 0;}
查询存储桶复制
功能说明
查询指定存储桶的存储桶复制规则。
方法原型
cos_status_t *cos_get_bucket_replication(const cos_request_options_t *options,const cos_string_t *bucket,cos_replication_params_t *replication_param,cos_table_t **resp_headers);
参数说明
参数名称 | 参数描述 | 类型 |
options | COS 请求选项 | Struct |
bucket | 存储桶名称,存储桶的命名格式为 BucketName-APPID,此处填写的存储桶名称必须为此格式 | String |
replication_param | 存储桶复制请求操作参数 | Struct |
role | 操作者账户信息 | String |
rule_list | 存储桶复制规则配置信息 | Struct |
id | 用来标注具体规则的名称 | String |
status | 标识规则是否生效,枚举值:Enabled,Disabled | String |
prefix | 匹配前缀。不可重叠,重叠返回错误 | String |
dst_bucket | 目标存储桶,资源标识符格式为: qcs::cos:[region]::[bucketname-AppId] | String |
storage_class | String | |
resp_headers | 返回 HTTP 响应消息的头域 | Struct |
返回结果说明
返回结果 | 描述 | 类型 |
code | 错误码 | Int |
error_code | 错误码内容 | String |
error_msg | 错误码描述 | String |
req_id | 请求消息 ID | String |
示例
#include "cos_http_io.h"#include "cos_api.h"#include "cos_log.h"#include <unistd.h>// endpoint 是 COS 访问域名信息,详情请参见 https://cloud.tencent.com/document/product/436/6224 文档static char TEST_COS_ENDPOINT[] = "cos.ap-guangzhou.myqcloud.com";// 开发者拥有的项目身份ID/密钥,可在 https://console.cloud.tencent.com/cam/capi 页面获取static char *TEST_ACCESS_KEY_ID; //your secret_idstatic char *TEST_ACCESS_KEY_SECRET; //your secret_key// 开发者访问 COS 服务时拥有的用户维度唯一资源标识,用以标识资源,可在 https://console.cloud.tencent.com/cam/capi 页面获取static char TEST_APPID[] = "<APPID>"; //your appid//the cos bucket name, syntax: [bucket]-[appid], for example: mybucket-1253666666,可在 https://console.cloud.tencent.com/cos5/bucket 查看static char TEST_BUCKET_NAME[] = "<bucketname-appid>";void log_status(cos_status_t *s){cos_warn_log("status->code: %d", s->code);if (s->error_code) cos_warn_log("status->error_code: %s", s->error_code);if (s->error_msg) cos_warn_log("status->error_msg: %s", s->error_msg);if (s->req_id) cos_warn_log("status->req_id: %s", s->req_id);}void init_test_config(cos_config_t *config, int is_cname){cos_str_set(&config->endpoint, TEST_COS_ENDPOINT);cos_str_set(&config->access_key_id, TEST_ACCESS_KEY_ID);cos_str_set(&config->access_key_secret, TEST_ACCESS_KEY_SECRET);cos_str_set(&config->appid, TEST_APPID);config->is_cname = is_cname;}void init_test_request_options(cos_request_options_t *options, int is_cname){options->config = cos_config_create(options->pool);init_test_config(options->config, is_cname);options->ctl = cos_http_controller_create(options->pool, 0);}void test_get_replication(){cos_pool_t *p = NULL;int is_cname = 0;cos_status_t *s = NULL;cos_request_options_t *options = NULL;cos_string_t bucket;cos_table_t *resp_headers = NULL;//初始化请求选项cos_pool_create(&p, NULL);options = cos_request_options_create(p);init_test_request_options(options, is_cname);cos_str_set(&bucket, TEST_BUCKET_NAME);//查询存储桶复制规则cos_replication_params_t *replication_param2 = NULL;replication_param2 = cos_create_replication_params(p);s = cos_get_bucket_replication(options, &bucket, replication_param2, &resp_headers);if (cos_status_is_ok(s)) {printf("get bucket replication succeeded\\n");printf("ReplicationConfiguration role: %s\\n", replication_param2->role.data);cos_replication_rule_content_t *content = NULL;cos_list_for_each_entry(cos_replication_rule_content_t, content, &replication_param2->rule_list, node) {printf("ReplicationConfiguration rule, id:%s, status:%s, prefix:%s, dst_bucket:%s, storage_class:%s\\n",content->id.data, content->status.data, content->prefix.data, content->dst_bucket.data, content->storage_class.data);}} else {printf("get bucket replication failed\\n");}cos_pool_destroy(p);}int main(int argc, char *argv[]){// 通过环境变量获取 SECRETID 和 SECRETKEYTEST_ACCESS_KEY_ID = getenv("COS_SECRETID");TEST_ACCESS_KEY_SECRET = getenv("COS_SECRETKEY");if (cos_http_io_initialize(NULL, 0) != COSE_OK) {exit(1);}//set log level, default COS_LOG_WARNcos_log_set_level(COS_LOG_WARN);//set log output, default stderrcos_log_set_output(NULL);test_get_replication();cos_http_io_deinitialize();return 0;}
删除存储桶复制
功能说明
删除指定存储桶的存储桶复制规则。
方法原型
cos_status_t *cos_delete_bucket_replication(const cos_request_options_t *options,const cos_string_t *bucket,cos_table_t **resp_headers);
参数说明
参数名称 | 参数描述 | 类型 |
options | COS 请求选项 | Struct |
bucket | 存储桶名称,存储桶的命名格式为 BucketName-APPID,此处填写的存储桶名称必须为此格式 | String |
resp_headers | 返回 HTTP 响应消息的头域 | Struct |
返回结果说明
返回结果 | 描述 | 类型 |
code | 错误码 | Int |
error_code | 错误码内容 | String |
error_msg | 错误码描述 | String |
req_id | 请求消息 ID | String |
示例
#include "cos_http_io.h"#include "cos_api.h"#include "cos_log.h"#include <unistd.h>// endpoint 是 COS 访问域名信息,详情请参见 https://cloud.tencent.com/document/product/436/6224 文档static char TEST_COS_ENDPOINT[] = "cos.ap-guangzhou.myqcloud.com";// 开发者拥有的项目身份ID/密钥,可在 https://console.cloud.tencent.com/cam/capi 页面获取static char *TEST_ACCESS_KEY_ID; //your secret_idstatic char *TEST_ACCESS_KEY_SECRET; //your secret_key// 开发者访问 COS 服务时拥有的用户维度唯一资源标识,用以标识资源,可在 https://console.cloud.tencent.com/cam/capi 页面获取static char TEST_APPID[] = "<APPID>"; //your appid//the cos bucket name, syntax: [bucket]-[appid], for example: mybucket-1253666666,可在 https://console.cloud.tencent.com/cos5/bucket 查看static char TEST_BUCKET_NAME[] = "<bucketname-appid>";void log_status(cos_status_t *s){cos_warn_log("status->code: %d", s->code);if (s->error_code) cos_warn_log("status->error_code: %s", s->error_code);if (s->error_msg) cos_warn_log("status->error_msg: %s", s->error_msg);if (s->req_id) cos_warn_log("status->req_id: %s", s->req_id);}void init_test_config(cos_config_t *config, int is_cname){cos_str_set(&config->endpoint, TEST_COS_ENDPOINT);cos_str_set(&config->access_key_id, TEST_ACCESS_KEY_ID);cos_str_set(&config->access_key_secret, TEST_ACCESS_KEY_SECRET);cos_str_set(&config->appid, TEST_APPID);config->is_cname = is_cname;}void init_test_request_options(cos_request_options_t *options, int is_cname){options->config = cos_config_create(options->pool);init_test_config(options->config, is_cname);options->ctl = cos_http_controller_create(options->pool, 0);}void test_delete_replication(){cos_pool_t *p = NULL;int is_cname = 0;cos_status_t *s = NULL;cos_request_options_t *options = NULL;cos_string_t bucket;cos_table_t *resp_headers = NULL;//初始化请求选项cos_pool_create(&p, NULL);options = cos_request_options_create(p);init_test_request_options(options, is_cname);cos_str_set(&bucket, TEST_BUCKET_NAME);//删除存储桶复制规则s = cos_delete_bucket_replication(options, &bucket, &resp_headers);if (cos_status_is_ok(s)) {printf("delete bucket replication succeeded\\n");} else {printf("delete bucket replication failed\\n");}cos_pool_destroy(p);}int main(int argc, char *argv[]){// 通过环境变量获取 SECRETID 和 SECRETKEYTEST_ACCESS_KEY_ID = getenv("COS_SECRETID");TEST_ACCESS_KEY_SECRET = getenv("COS_SECRETKEY");if (cos_http_io_initialize(NULL, 0) != COSE_OK) {exit(1);}//set log level, default COS_LOG_WARNcos_log_set_level(COS_LOG_WARN);//set log output, default stderrcos_log_set_output(NULL);test_delete_replication();cos_http_io_deinitialize();return 0;}