简介
本文档提供关于生命周期的 API 概览以及 SDK 示例代码。
API | 操作名 | 操作描述 |
设置生命周期 | 设置存储桶的生命周期管理的配置 | |
查询生命周期 | 查询存储桶生命周期管理的配置 | |
删除生命周期 | 删除存储桶生命周期管理的配置 |
设置生命周期
功能说明
设置存储桶的生命周期配置信息。
方法原型
cos_status_t *cos_put_bucket_lifecycle(const cos_request_options_t *options,const cos_string_t *bucket,cos_list_t *lifecycle_rule_list,cos_table_t **resp_headers);
参数说明
参数名称 | 参数描述 | 类型 |
options | COS 请求选项 | Struct |
bucket | 存储桶名称,存储桶的命名格式为 BucketName-APPID ,此处填写的存储桶名称必须为此格式 | String |
lifecycle_rule_list | 生命周期规则信息 | Struct |
id | 生命周期规则 ID | String |
prefix | 指定规则所适用的前缀 | String |
status | 指明规则是否启用,枚举值:Enabled,Disabled | String |
expire | 规则过期属性 | Struct |
days | 指明多少天后执行删除操作或转换操作;指明分块上传开始后多少天内必须完成上传 | Int |
date | 指明在何时执行删除操作或转换操作 | String |
transition | 规则转换属性,对象何时转换被转换为 Standard_IA、Archive | Struct |
storage_class | String | |
abort | 设置允许分块上传保持运行的最长时间 | Struct |
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_bucket_lifecycle(){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_list_t rule_list;cos_list_init(&rule_list);cos_lifecycle_rule_content_t *rule_content = NULL;rule_content = cos_create_lifecycle_rule_content(p);cos_str_set(&rule_content->id, "testrule1");cos_str_set(&rule_content->prefix, "abc/");cos_str_set(&rule_content->status, "Enabled");rule_content->expire.days = 365;cos_list_add_tail(&rule_content->node, &rule_list);rule_content = cos_create_lifecycle_rule_content(p);cos_str_set(&rule_content->id, "testrule2");cos_str_set(&rule_content->prefix, "efg/");cos_str_set(&rule_content->status, "Disabled");cos_str_set(&rule_content->transition.storage_class, "Standard_IA");rule_content->transition.days = 999;cos_list_add_tail(&rule_content->node, &rule_list);rule_content = cos_create_lifecycle_rule_content(p);cos_str_set(&rule_content->id, "testrule3");cos_str_set(&rule_content->prefix, "xxx/");cos_str_set(&rule_content->status, "Enabled");rule_content->abort.days = 1;cos_list_add_tail(&rule_content->node, &rule_list);//设置生命周期s = cos_put_bucket_lifecycle(options, &bucket, &rule_list, &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_bucket_lifecycle();cos_http_io_deinitialize();return 0;}
查询生命周期
功能说明
查询存储桶的生命周期管理配置。
方法原型
cos_status_t *cos_get_bucket_lifecycle(const cos_request_options_t *options,const cos_string_t *bucket,cos_list_t *lifecycle_rule_list,cos_table_t **resp_headers);
参数说明
参数名称 | 参数描述 | 类型 |
options | COS 请求选项 | Struct |
bucket | 存储桶名称,存储桶的命名格式为 BucketName-APPID ,此处填写的存储桶名称必须为此格式 | String |
lifecycle_rule_list | 生命周期规则信息 | Struct |
id | 生命周期规则 ID | String |
prefix | 规则所适用的前缀 | String |
status | 规则是否启用,枚举值:Enabled,Disabled | String |
expire | 规则过期属性 | Struct |
days | 指明多少天后执行删除操作 | Int |
date | 指明在何时执行删除操作 | String |
transition | 规则转换属性,对象何时转换被转换为 Standard_IA、Archive | Struct |
days | 指明多少天后执行转换操作 | Int |
date | 指明在何时执行转换操作 | String |
storage_class | String | |
abort | 设置允许分块上传保持运行的最长时间 | Struct |
days | 指明分块上传开始后多少天内必须完成上传 | Int |
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_bucket_lifecycle(){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_list_t rule_list_ret;cos_list_init(&rule_list_ret);s = cos_get_bucket_lifecycle(options, &bucket, &rule_list_ret, &resp_headers);if (cos_status_is_ok(s)) {printf("get bucket lifecycle succeeded\\n");} else {printf("get bucket lifecycle 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_bucket_lifecycle();cos_http_io_deinitialize();return 0;}
删除生命周期
功能说明
删除存储桶生命周期管理的配置。
方法原型
cos_status_t *cos_delete_bucket_lifecycle(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_bucket_lifecycle(){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_lifecycle(options, &bucket, &resp_headers);if (cos_status_is_ok(s)) {printf("delete bucket lifecycle succeeded\\n");} else {printf("delete bucket lifecycle 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_bucket_lifecycle();cos_http_io_deinitialize();return 0;}