tencent cloud

文档反馈

自定义域名

最后更新时间:2022-01-23 14:43:51

    简介

    本文档提供关于自定义域名的 API 概览以及 SDK 示例代码。

    API 操作名 操作描述
    PUT Bucket domain 设置自定义域名 设置存储桶的自定义域名信息
    GET Bucket domain 查询自定义域名 查询存储桶的自定义域名信息

    设置自定义域名

    功能说明

    PUT Bucket domain 用于为存储桶配置自定义域名。

    方法原型

    cos_status_t *cos_put_bucket_domain(const cos_request_options_t *options,
                                        const cos_string_t *bucket,
                                        cos_domain_params_t *domain_params,
                                        cos_table_t **resp_header);
    

    请求示例

    #include "cos_http_io.h"
    #include "cos_api.h"
    #include "cos_log.h"
    // endpoint 是 COS 访问域名信息,详情请参见 https://intl.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_id
    static 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_domain()
    {
      cos_pool_t *pool = NULL;
      int is_cname = 0;
      cos_status_t *status = NULL;
      cos_request_options_t *options = NULL;
      cos_domain_params_t  *domain_params = NULL;
      cos_table_t *resp_headers = NULL;
      cos_string_t bucket;
    
      //创建内存池
      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);
    
      //创建 domain 参数
      domain_params = cos_create_domain_params(options->pool);
      cos_str_set(&domain_params->status, "ENABLED");
      cos_str_set(&domain_params->name, "www.exmaple.com");
      cos_str_set(&domain_params->type, "REST");
      cos_str_set(&domain_params->forced_replacement, "CNAME");
    
      status = cos_put_bucket_domain(options, &bucket, domain_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_bucket_domain();
       cos_http_io_deinitialize();
       return 0;
    }
    

    参数说明

    参数名称 描述 类型
    options COS 请求选项 Struct
    bucket 设置自定义域名的存储桶,格式为 BucketName-APPID ,详情请参见 命名规范 String
    domain_params 存储桶自定义域名配置信息 Struct
    status 域名上线/下线状态,有效值 ENABLED/DISABLED String
    name 用户的自定义域名,有效值:字母、数字、点 String
    type 绑定的源站类型,有效值 REST/WEBSITE String
    forced_replacement 替换已存在的配置,有效值 CNAME/TXT。填写则强制校验域名所有权后,再下发配置 String
    resp_headers 返回 HTTP 响应消息的头域 Struct

    返回结果说明

    返回结果 描述 类型
    code 错误码 Int
    error_code 错误码内容 String
    error_msg 错误码描述 String
    req_id 请求消息 ID String

    返回错误码说明

    该请求可能会发生的一些常见的特殊错误如下:

    状态码 说明
    HTTP 409 Conflict 该域名记录已存在,且请求中没有设置强制覆盖。或者该域名记录不存在,且请求中设置了强制覆盖
    HTTP 451 Unavailable For Legal Reasons 该域名是中国境内域名,并且没有备案

    查询自定义域名

    功能说明

    GET Bucket domain 用于查询存储桶的自定义域名信息。

    方法原型

    cos_status_t *cos_get_bucket_domain(const cos_request_options_t *options,
                                        const cos_string_t *bucket,
                                        cos_domain_params_t *domain_params,
                                        cos_table_t **resp_header);
    

    请求示例

    #include "cos_http_io.h"
    #include "cos_api.h"
    #include "cos_log.h"
    // endpoint 是 COS 访问域名信息,详情请参见 https://intl.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_id
    static 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_domain()
    {
      cos_pool_t *pool = NULL;
      int is_cname = 0;
      cos_status_t *status = NULL;
      cos_request_options_t *options = NULL;
      cos_domain_params_t  *domain_result = NULL;
      cos_table_t *resp_headers = NULL;
      cos_string_t bucket;
    
      //创建内存池
      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);
    
      // 查询自定义域名配置
      domain_result = cos_create_domain_params(options->pool);
      status = cos_get_bucket_domain(options, &bucket, domain_result, &resp_headers);
      log_status(status);
      if (!cos_status_is_ok(status)) {
          cos_pool_destroy(pool);
          return;
      }
    
      //查看结果
      char *line = NULL;
      line = apr_psprintf(options->pool, "%.*s\n", domain_result->status.len, domain_result->status.data);
      printf("status: %s", line);
      line = apr_psprintf(options->pool, "%.*s\n", domain_result->name.len, domain_result->name.data);
      printf("name: %s", line);
      line = apr_psprintf(options->pool, "%.*s\n", domain_result->type.len, domain_result->type.data);
      printf("type: %s", line);
      line = apr_psprintf(options->pool, "%.*s\n", domain_result->forced_replacement.len, domain_result->forced_replacement.data);
      printf("forced_replacement: %s", line);
       // 销毁内存池
      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_bucket_domain();
       cos_http_io_deinitialize();
       return 0;
    }
    

    参数说明

    参数名称 描述 类型
    options COS 请求选项 Struct
    bucket 查询自定义域名的存储桶,格式为 BucketName-APPID ,详情请参见 命名规范 String
    domain_params 存储桶自定义域名配置信息 Struct
    status 域名上线/下线状态,有效值 ENABLED/DISABLED String
    name 用户的自定义域名,有效值:字母、数字、点 String
    type 绑定的源站类型,有效值 REST/WEBSITE String
    forced_replacement 替换已存在的配置,有效值 CNAME/TXT。填写则强制校验域名所有权后,再下发配置 String
    resp_headers 返回 HTTP 响应消息的头域 Struct

    返回结果说明

    返回结果 描述 类型
    code 错误码 Int
    error_code 错误码内容 String
    error_msg 错误码描述 String
    req_id 请求消息 ID String
    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持