简介
本文档提供关于存储桶 Referer 白名单或者黑名单的 API 概览以及 SDK 示例代码。
API | 操作名 | 操作描述 |
PUT Bucket referer | 设置存储桶 Referer | 设置存储桶 Referer 白名单或者黑名单 |
GET Bucket referer | 查询存储桶 Referer | 查询存储桶 Referer 白名单或者黑名单 |
设置存储桶 Referer
功能说明
设置指定存储桶的 Referer 白名单或者黑名单(PUT Bucket referer)。
方法原型
cos_status_t *cos_put_bucket_referer(const cos_request_options_t *options, const cos_string_t *bucket, cos_referer_params_t *referer_params, cos_table_t **resp_headers);
参数说明
参数名称 | 参数描述 | 类型 |
options | COS 请求选项 | Struct |
bucket | 存储桶名称,Bucket 的命名规则为 BucketName-APPID ,此处填写的存储桶名称必须为此格式 | String |
referer_params | referer配置参数 | Struct |
status | 是否开启防盗链,枚举值:Enabled、Disabled | String |
referer_type | 防盗链类型,枚举值:Black-List、White-List | String |
empty_refer_config | 是否允许空 Referer 访问,枚举值:Allow、Deny,默认值为 Deny | String |
domain_list | 生效域名列表, 支持多个域名且为前缀匹配, 支持带端口的域名和 IP, 支持通配符*,做二级域名或多级域名的通配 | String |
resp_headers | 返回 HTTP 响应消息的头域 | Struct |
返回结果说明
返回结果 | 描述 | 类型 |
code | 错误码 | Int |
error_code | 错误码内容 | String |
error_msg | 错误码描述 | String |
req_id | 请求消息 ID | String |
示例
完整代码请参见 cos_demo.c 中的 test_referer() 函数。
#include "cos_http_io.h"#include "cos_api.h"#include "cos_log.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[] = ""; //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[] = "";
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_referer(){ cos_pool_t *pool = NULL; int is_cname = 0; cos_status_t *status = NULL; cos_request_options_t *options = NULL; cos_table_t *resp_headers = NULL; cos_string_t bucket; cos_referer_params_t *params = NULL; cos_referer_domain_t *domain = NULL;
//创建内存池 cos_pool_create(&pool, NULL);
//初始化请求选项 options = cos_request_options_create(pool); init_test_request_options(options, is_cname); cos_str_set(&bucket, TEST_BUCKET_NAME);
// 替换为您的配置信息,可参见文档 https://cloud.tencent.com/document/product/436/32492 params = cos_create_referer_params(pool); cos_str_set(¶ms->status, "Enabled"); cos_str_set(¶ms->referer_type, "White-List"); cos_str_set(¶ms->empty_refer_config, "Allow"); domain = cos_create_referer_domain(pool); cos_str_set(&domain->domain, "www.qq.com"); cos_list_add_tail(&domain->node, ¶ms->domain_list); domain = cos_create_referer_domain(pool); cos_str_set(&domain->domain, "*.tencent.com"); cos_list_add_tail(&domain->node, ¶ms->domain_list);
// put referer status = cos_put_bucket_referer(options, &bucket, params, &resp_headers); log_status(status);
cos_pool_destroy(pool);}
int main(int argc, char *argv[]){ // 通过环境变量获取 SECRETID 和 SECRETKEY TEST_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_WARN cos_log_set_level(COS_LOG_WARN);
//set log output, default stderr cos_log_set_output(NULL);
test_put_referer();
cos_http_io_deinitialize();
return 0;}
查询存储桶 Referer
功能说明
查询指定存储桶 Referer 白名单或者黑名单(GET Bucket referer)。
方法原型
cos_status_t *cos_get_bucket_referer(const cos_request_options_t *options, const cos_string_t *bucket, cos_referer_params_t *referer_params, cos_table_t **resp_headers);
参数说明
参数名称 | 参数描述 | 类型 |
options | COS 请求选项 | Struct |
bucket | 存储桶名称,Bucket 的命名规则为 BucketName-APPID ,此处填写的存储桶名称必须为此格式 | String |
referer_params | referer配置参数 | Struct |
status | 是否开启防盗链,枚举值:Enabled、Disabled | String |
referer_type | 防盗链类型,枚举值:Black-List、White-List | String |
empty_refer_config | 是否允许空 Referer 访问,枚举值:Allow、Deny,默认值为 Deny | String |
domain_list | 生效域名列表, 支持多个域名且为前缀匹配, 支持带端口的域名和 IP, 支持通配符*,做二级域名或多级域名的通配 | String |
resp_headers | 返回 HTTP 响应消息的头域 | Struct |
返回结果说明
返回结果 | 描述 | 类型 |
code | 错误码 | Int |
error_code | 错误码内容 | String |
error_msg | 错误码描述 | String |
req_id | 请求消息 ID | String |
请求示例
完整代码请参见 cos_demo.c 中的 test_referer() 函数。
#include "cos_http_io.h"#include "cos_api.h"#include "cos_log.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[] = ""; //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[] = "";
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);}
static void log_get_referer(cos_referer_params_t *result){ int index = 0; cos_referer_domain_t *domain;
cos_warn_log("status: %s", result->status.data); cos_warn_log("referer_type: %s", result->referer_type.data); cos_warn_log("empty_refer_config: %s", result->empty_refer_config.data);
cos_list_for_each_entry(cos_referer_domain_t, domain, &result->domain_list, node) { cos_warn_log("domain index:%d", ++index); cos_warn_log("domain: %s", domain->domain.data); }}
void test_get_referer(){ cos_pool_t *pool = NULL; int is_cname = 0; cos_status_t *status = NULL; cos_request_options_t *options = NULL; cos_table_t *resp_headers = NULL; cos_string_t bucket; cos_referer_params_t *result = NULL;
//创建内存池 cos_pool_create(&pool, NULL);
//初始化请求选项 options = cos_request_options_create(pool); init_test_request_options(options, is_cname); cos_str_set(&bucket, TEST_BUCKET_NAME);
// get referer result = cos_create_referer_params(pool); status = cos_get_bucket_referer(options, &bucket, result, &resp_headers); log_status(status); if (status->code == 200) { log_get_referer(result); }
cos_pool_destroy(pool);}
int main(int argc, char *argv[]){ // 通过环境变量获取 SECRETID 和 SECRETKEY TEST_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_WARN cos_log_set_level(COS_LOG_WARN);
//set log output, default stderr cos_log_set_output(NULL);
test_get_referer();
cos_http_io_deinitialize();
return 0;}
对象存储官网1折活动,限时活动,即将结束,速速收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折,更有现金返利。同意关联立享优惠
转转请注明出处:https://www.yunxiaoer.com/145463.html