tencent cloud

文档反馈

访问控制

最后更新时间:2024-01-04 17:06:08

    简介

    本文档提供关于存储桶、对象的访问控制列表(ACL)的相关 API 概览以及 SDK 示例代码。
    存储桶 ACL
    API
    操作名
    操作描述
    设置存储桶 ACL
    设置指定存储桶的访问权限控制列表(ACL)
    查询存储桶 ACL
    获取指定存储桶的访问权限控制列表(ACL)
    对象 ACL
    API
    操作名
    操作描述
    设置对象 ACL
    设置 Bucket 中某个 Object (文件/对象)的 ACL
    查询对象 ACL
    查询 Object(文件/对象)的 ACL

    存储桶 ACL

    设置存储桶 ACL

    功能说明

    设置指定存储桶的访问权限控制列表(ACL)。

    方法原型

    cos_status_t *cos_put_bucket_acl(const cos_request_options_t *options,
    const cos_string_t *bucket,
    cos_acl_e cos_acl,
    const cos_string_t *grant_read,
    const cos_string_t *grant_write,
    const cos_string_t *grant_full_ctrl,
    cos_table_t **resp_headers);

    参数说明

    参数名称
    参数描述
    类型
    options
    COS 请求选项
    Struct
    bucket
    存储桶名称,存储桶的命名格式为 BucketName-APPID,此处填写的存储桶名称必须为此格式
    String
    cos_acl
    允许用户自定义权限。
    有效值:COS_ACL_PRIVATE(0),COS_ACL_PUBLIC_READ(1),COS_ACL_PUBLIC_READ_WRITE(2)
    默认值:COS_ACL_PRIVATE(0)
    Enum
    grant_read
    读权限授予者
    String
    grant_write
    写权限授予者
    String
    grant_full_ctrl
    读写权限授予者
    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"
    
    // endpoint 是 COS 访问域名信息,详情请参见 https://www.tencentcloud.com/document/product/436/6224 文档
    static char TEST_COS_ENDPOINT[] = "cos.ap-guangzhou.myqcloud.com";
    // 开发者拥有的项目身份ID/密钥,可在 https://console.tencentcloud.com/cam/capi 页面获取
    static char *TEST_ACCESS_KEY_ID; //your secret_id
    static char *TEST_ACCESS_KEY_SECRET; //your secret_key
    // 开发者访问 COS 服务时拥有的用户维度唯一资源标识,用以标识资源,可在 https://console.tencentcloud.com/cam/capi 页面获取
    static char TEST_APPID[] = "<APPID>"; //your appid
    //the cos bucket name, syntax: [bucket]-[appid], for example: mybucket-1253666666,可在 https://console.tencentcloud.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_acl()
    {
    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_acl_e cos_acl = COS_ACL_PRIVATE; //替换为您自己的配置
    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);
    
    //设置存储桶 ACL
    cos_string_t read;
    cos_str_set(&read, "id=\\"qcs::cam::uin/100000000001:uin/100000000001\\", id=\\"qcs::cam::uin/100000000011:uin/100000000011\\"");
    s = cos_put_bucket_acl(options, &bucket, cos_acl, &read, NULL, NULL, &resp_headers);
    if (cos_status_is_ok(s)) {
    printf("put bucket acl succeeded\\n");
    } else {
    printf("put bucket acl failed\\n");
    }
    
    //销毁内存池
    cos_pool_destroy(p);
    }
    
    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_acl();
    
    cos_http_io_deinitialize();
    
    return 0;
    }

    查询存储桶 ACL

    功能说明

    获取指定存储桶的访问权限控制列表(ACL)。

    方法原型

    cos_status_t *cos_get_bucket_acl(const cos_request_options_t *options,
    const cos_string_t *bucket,
    cos_acl_params_t *acl_param,
    cos_table_t **resp_headers)

    参数说明

    参数名称
    参数描述
    类型
    options
    COS 请求选项
    Struct
    bucket
    存储桶名称,存储桶的命名格式为 BucketName-APPID,此处填写的存储桶名称必须为此格式
    String
    acl_param
    请求操作参数
    Struct
    owner_id
    请求操作返回的存储桶持有者 ID
    String
    owner_name
    请求操作返回的存储桶持有者的名称
    String
    object_list
    请求操作返回的被授权者信息与权限信息
    Struct
    type
    请求操作返回的被授权者账户类型
    String
    id
    请求操作返回的被授权者用户 ID
    String
    name
    请求操作返回的被授权者用户名称
    String
    permission
    请求操作返回的被授权者权限信息
    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"
    
    // endpoint 是 COS 访问域名信息,详情请参见 https://www.tencentcloud.com/document/product/436/6224 文档
    static char TEST_COS_ENDPOINT[] = "cos.ap-guangzhou.myqcloud.com";
    // 开发者拥有的项目身份ID/密钥,可在 https://console.tencentcloud.com/cam/capi 页面获取
    static char *TEST_ACCESS_KEY_ID; //your secret_id
    static char *TEST_ACCESS_KEY_SECRET; //your secret_key
    // 开发者访问 COS 服务时拥有的用户维度唯一资源标识,用以标识资源,可在 https://console.tencentcloud.com/cam/capi 页面获取
    static char TEST_APPID[] = "<APPID>"; //your appid
    //the cos bucket name, syntax: [bucket]-[appid], for example: mybucket-1253666666,可在 https://console.tencentcloud.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_acl()
    {
    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);
    
    //获取存储桶 ACL
    cos_acl_params_t *acl_params = NULL;
    acl_params = cos_create_acl_params(p);
    s = cos_get_bucket_acl(options, &bucket, acl_params, &resp_headers);
    if (cos_status_is_ok(s)) {
    printf("get bucket acl succeeded\\n");
    printf("acl owner id:%s, name:%s\\n", acl_params->owner_id.data, acl_params->owner_name.data);
    cos_acl_grantee_content_t *acl_content = NULL;
    cos_list_for_each_entry(cos_acl_grantee_content_t, acl_content, &acl_params->grantee_list, node) {
    printf("acl grantee type:%s, id:%s, name:%s, permission:%s\\n", acl_content->type.data, acl_content->id.data, acl_content->name.data, acl_content->permission.data);
    }
    } else {
    printf("get bucket acl failed\\n");
    }
    
    //销毁内存池
    cos_pool_destroy(p);
    }
    
    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_acl();
    
    cos_http_io_deinitialize();
    
    return 0;
    }

    对象 ACL

    设置对象 ACL

    功能说明

    设置指定对象访问权限控制列表(ACL)(PUT Object acl)。

    方法原型

    cos_status_t *cos_put_object_acl(const cos_request_options_t *options,
    const cos_string_t *bucket,
    const cos_string_t *object,
    cos_acl_e cos_acl,
    const cos_string_t *grant_read,
    const cos_string_t *grant_write,
    const cos_string_t *grant_full_ctrl,
    cos_table_t **resp_headers);

    参数说明

    参数名称
    参数描述
    类型
    options
    COS 请求选项
    Struct
    bucket
    存储桶名称,存储桶的命名格式为 BucketName-APPID,此处填写的存储桶名称必须为此格式
    String
    object
    Object 名称
    String
    cos_acl
    允许用户自定义权限。有效值:COS_ACL_PRIVATE(0),COS_ACL_PUBLIC_READ(1), COS_ACL_PUBLIC_READ_WRITE(2)
    默认值:COS_ACL_PRIVATE(0)
    Enum
    grant_read
    赋予被授权者读取对象的权限,格式为 id="[OwnerUin]",例如 id="100000000001",可使用半角逗号(,)分隔多组被授权者,例如id="100000000001",id="100000000002"
    String
    grant_write
    赋予被授权者写入对象的权限,格式为 id="[OwnerUin]",例如 id="100000000001",可使用半角逗号(,)分隔多组被授权者,例如id="100000000001",id="100000000002"
    String
    grant_full_ctrl
    赋予被授权者操作对象的所有权限,格式为 id="[OwnerUin]",例如 id="100000000001",可使用半角逗号(,)分隔多组被授权者,例如id="100000000001",id="100000000002"
    String
    resp_headers
    返回 HTTP 响应消息的头域
    Struct
    说明
    详情请参见 API 文档 PUT Object aclACL 概述

    返回结果说明

    返回结果
    描述
    类型
    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"
    
    // endpoint 是 COS 访问域名信息,详情请参见 https://www.tencentcloud.com/document/product/436/6224 文档
    static char TEST_COS_ENDPOINT[] = "cos.ap-guangzhou.myqcloud.com";
    // 开发者拥有的项目身份ID/密钥,可在 https://console.tencentcloud.com/cam/capi 页面获取
    static char *TEST_ACCESS_KEY_ID; //your secret_id
    static char *TEST_ACCESS_KEY_SECRET; //your secret_key
    // 开发者访问 COS 服务时拥有的用户维度唯一资源标识,用以标识资源,可在 https://console.tencentcloud.com/cam/capi 页面获取
    static char TEST_APPID[] = "<APPID>"; //your appid
    //the cos bucket name, syntax: [bucket]-[appid], for example: mybucket-1253666666,可在 https://console.tencentcloud.com/cos5/bucket 查看
    static char TEST_BUCKET_NAME[] = "<bucketname-appid>";
    // 对象键,对象(Object)在存储桶(Bucket)中的唯一标识。有关对象与对象键的进一步说明,请参见 https://www.tencentcloud.com/document/product/436/13324 文档
    static char TEST_OBJECT_NAME1[] = "1.txt";
    
    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_object_acl()
    {
    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_string_t object;
    cos_acl_e cos_acl = COS_ACL_PRIVATE; //替换为您自己的配置
    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);
    
    //设置对象 ACL,替换您自己的acl配置
    cos_str_set(&object, TEST_OBJECT_NAME1);
    cos_string_t read;
    cos_str_set(&read, "id=\\"qcs::cam::uin/12345:uin/12345\\", id=\\"qcs::cam::uin/45678:uin/45678\\"");
    s = cos_put_object_acl(options, &bucket, &object, cos_acl, &read, NULL, NULL, &resp_headers);
    if (cos_status_is_ok(s)) {
    printf("put object acl succeeded\\n");
    } else {
    printf("put object acl failed\\n");
    }
    
    //销毁内存池
    cos_pool_destroy(p);
    }
    
    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_object_acl();
    
    cos_http_io_deinitialize();
    
    return 0;
    }

    查询对象 ACL

    功能说明

    查询指定对象的访问权限控制列表(GET Object acl)。

    方法原型

    cos_status_t *cos_get_object_acl(const cos_request_options_t *options,
    const cos_string_t *bucket,
    const cos_string_t *object,
    cos_acl_params_t *acl_param,
    cos_table_t **resp_headers)

    参数说明

    参数名称
    参数描述
    类型
    options
    COS 请求选项
    Struct
    bucket
    存储桶名称,存储桶的命名格式为 BucketName-APPID,此处填写的存储桶名称必须为此格式
    String
    object
    Object 名称
    String
    acl_param
    请求操作参数
    Struct
    owner_id
    请求操作返回的 Bucket 持有者 ID
    String
    owner_name
    请求操作返回的 Bucket 持有者的名称
    String
    object_list
    请求操作返回的被授权者信息与权限信息
    Struct
    type
    请求操作返回的被授权者账户类型
    String
    id
    请求操作返回的被授权者用户 ID
    String
    name
    请求操作返回的被授权者用户名称
    String
    permission
    请求操作返回的被授权者权限信息
    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"
    
    // endpoint 是 COS 访问域名信息,详情请参见 https://www.tencentcloud.com/document/product/436/6224 文档
    static char TEST_COS_ENDPOINT[] = "cos.ap-guangzhou.myqcloud.com";
    // 开发者拥有的项目身份ID/密钥,可在 https://console.tencentcloud.com/cam/capi 页面获取
    static char *TEST_ACCESS_KEY_ID; //your secret_id
    static char *TEST_ACCESS_KEY_SECRET; //your secret_key
    // 开发者访问 COS 服务时拥有的用户维度唯一资源标识,用以标识资源,可在 https://console.tencentcloud.com/cam/capi 页面获取
    static char TEST_APPID[] = "<APPID>"; //your appid
    //the cos bucket name, syntax: [bucket]-[appid], for example: mybucket-1253666666,可在 https://console.tencentcloud.com/cos5/bucket 查看
    static char TEST_BUCKET_NAME[] = "<bucketname-appid>";
    // 对象键,对象(Object)在存储桶(Bucket)中的唯一标识。有关对象与对象键的进一步说明,请参见 https://www.tencentcloud.com/document/product/436/13324 文档
    static char TEST_OBJECT_NAME1[] = "1.txt";
    
    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_object_acl()
    {
    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_string_t object;
    cos_acl_grantee_content_t *acl_content = NULL;
    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(&object, TEST_OBJECT_NAME1);
    
    //获取对象 ACL
    cos_acl_params_t *acl_params2 = NULL;
    acl_params2 = cos_create_acl_params(p);
    s = cos_get_object_acl(options, &bucket, &object, acl_params2, &resp_headers);
    if (cos_status_is_ok(s)) {
    printf("get object acl succeeded\\n");
    printf("acl owner id:%s, name:%s\\n", acl_params2->owner_id.data, acl_params2->owner_name.data);
    acl_content = NULL;
    cos_list_for_each_entry(cos_acl_grantee_content_t, acl_content, &acl_params2->grantee_list, node) {
    printf("acl grantee id:%s, name:%s, permission:%s\\n", acl_content->id.data, acl_content->name.data, acl_content->permission.data);
    }
    } else {
    printf("get object acl failed\\n");
    }
    
    //销毁内存池
    cos_pool_destroy(p);
    }
    
    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_object_acl();
    
    cos_http_io_deinitialize();
    
    return 0;
    }
    
    联系我们

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

    技术支持

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

    7x24 电话支持