访问控制

最后更新时间:2020-05-29 12:02:04

    简介

    本文档提供关于存储桶、对象的访问控制列表(ACL)的相关 API 概览以及 SDK 示例代码。

    存储桶 ACL

    API 操作名 操作描述
    PUT Bucket acl 设置存储桶 ACL 设置指定存储桶的访问权限控制列表
    GET Bucket acl 查询存储桶 ACL 查询指定存储桶的访问控制列表

    对象 ACL

    API 操作名 操作描述
    PUT Object acl 设置对象 ACL 设置存储桶中某个对象的访问控制列表
    GET Object acl 查询对象 ACL 查询对象的访问控制列表

    存储桶 ACL

    设置存储桶 ACL

    功能说明

    设置指定存储桶的访问权限控制列表(PUT Bucket acl)。AccessControlPolicy 参数与其它权限参数是互斥的,无法同时指定。

    方法原型

    put_bucket_acl(Bucket, AccessControlPolicy={}, **kwargs)

    请求示例

    response = client.put_bucket_acl(
        Bucket='examplebucket-1250000000',
        ACL='public-read'
    )

    全部参数请求示例

    response = client.put_bucket_acl(
        Bucket='examplebucket-1250000000',
        ACL='private'|'public-read'|'public-read-write',
        GrantFullControl='string',
        GrantRead='string',
        GrantWrite='string',
        AccessControlPolicy={
            'AccessControlList': {
                'Grant': [
                    {
                        'Grantee': {
                            'DisplayName': 'string',
                            'Type': 'CanonicalUser'|'Group',
                            'ID': 'string',
                            'URI': 'string'
                        },
                        'Permission': 'FULL_CONTROL'|'WRITE'|'READ'
                    },
                ]
            },
            'Owner': {
                'DisplayName': 'string',
                'ID': 'string'
            }
        }
    )

    参数说明

    参数名称 参数描述 类型 是否必填
    Bucket 存储桶名称,由 BucketName-APPID 构成 String
    ACL 设置存储桶的 ACL,例如 'private','public-read','public-read-write' String
    GrantFullControl 赋予指定账户对存储桶的读写权限,格式为id="OwnerUin" String
    GrantRead 赋予指定账户对存储桶的读权限,格式为id="OwnerUin" String
    GrantWrite 赋予指定账户对存储桶的写权限,格式为id="OwnerUin" String
    AccessControlPolicy 赋予指定账户对存储桶的访问权限,具体格式见 GET Bucket acl 返回结果说明 Dict

    返回结果说明

    该方法返回值为 None。

    查询存储桶 ACL

    功能说明

    查询指定存储桶的访问权限控制列表(GET Bucket acl)。

    方法原型

    get_bucket_acl(Bucket, **kwargs)

    请求示例

    response = client.get_bucket_acl(
        Bucket='examplebucket-1250000000'
    )

    参数说明

    参数名称 参数描述 类型 是否必填
    Bucket 存储桶名称,由 BucketName-APPID 构成 String

    返回结果说明

    Bucket ACL 信息,类型为 dict。

    {
        'Owner': {
            'DisplayName': 'string',
            'ID': 'string'
        },
        'Grant': [
            {
                'Grantee': {
                    'DisplayName': 'string',
                    'Type': 'CanonicalUser'|'Group',
                    'ID': 'string',
                    'URI': 'string'
                },
                'Permission': 'FULL_CONTROL'|'WRITE'|'READ'
            },
        ]
    }
    参数名称 参数描述 类型
    Owner 存储桶拥有者的信息,包括 DisplayName 和 ID Dict
    Grant 存储桶权限被授予者的信息,包括 Grantee 和 Permission List
    Grantee 权限被授予者的信息,包括 DisplayName,Type,ID 和 URI Dict
    DisplayName 权限被授予者的名称 String
    Type 权限被授予者的类型,类型为 CanonicalUser 或者 Group String
    ID Type 为 CanonicalUser 时,对应权限授予者的 ID String
    URI Type 为 Group 时,对应权限授予者的 URI String
    Permission 指明授予被授权者的存储桶权限,可选值有 FULL_CONTROL,WRITE,READ,分别对应读写权限、写权限、读权限 String

    对象 ACL

    设置对象 ACL

    功能说明

    设置存储桶中某个对象的访问控制列表(PUT Object acl)。AccessControlPolicy 参数与其它权限参数是互斥的,无法同时指定。

    方法原型

    put_object_acl(Bucket, Key, AccessControlPolicy={}, **kwargs)

    请求示例

    response = client.put_object_acl(
        Bucket='examplebucket-1250000000',
        Key='exampleobject',
        ACL='public-read'
    )

    全部参数请求示例

    response = client.put_object_acl(
        Bucket='examplebucket-1250000000',
        Key='exampleobject',
        ACL='private'|'public-read',
        GrantFullControl='string',
        GrantRead='string',
        AccessControlPolicy={
            'AccessControlList': {
                'Grant': [
                    {
                        'Grantee': {
                            'DisplayName': 'string',
                            'Type': 'CanonicalUser'|'Group',
                            'ID': 'string',
                            'URI': 'string'
                        },
                        'Permission': 'FULL_CONTROL'|'WRITE'|'READ'
                    },
                ]
            },
            'Owner': {
                'DisplayName': 'string',
                'ID': 'string'
            }
        }
    )

    参数说明

    参数名称 参数描述 类型 是否必填
    Bucket 存储桶名称,由 BucketName-APPID 构成 String
    Key 对象键(Key)是对象在存储桶中的唯一标识。例如,在对象的访问域名examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/doc/pic.jpg中,对象键为 doc/pic.jpg String
    ACL 设置对象的 ACL,例如 'private','public-read' String
    GrantFullControl 赋予指定账户对对象的所有权限,格式为id="OwnerUin" String
    GrantRead 赋予指定账户对对象的读权限,格式为id="OwnerUin" String
    AccessControlPolicy 赋予指定账户对对象的访问权限,具体格式见 GET Object acl 返回结果说明 Dict

    返回结果说明

    该方法返回值为 None。

    查询对象 ACL

    功能说明

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

    方法原型

    get_object_acl(Bucket, Key, **kwargs)

    请求示例

    response = client.get_object_acl(
        Bucket='examplebucket-1250000000',
        Key='exampleobject'
    )

    参数说明

    参数名称 参数描述 类型 是否必填
    Bucket 存储桶名称,由 BucketName-APPID 构成 String
    Key 对象键(Key)是对象在存储桶中的唯一标识。例如,在对象的访问域名examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/doc/pic.jpg中,对象键为 doc/pic.jpg String

    返回结果说明

    Bucket ACL 信息,类型为 Dict:

    {
        'Owner': {
            'DisplayName': 'string',
            'ID': 'string'
        },
        'Grant': [
            {
                'Grantee': {
                    'DisplayName': 'string',
                    'Type': 'CanonicalUser'|'Group',
                    'ID': 'string',
                    'URI': 'string'
                },
                'Permission': 'FULL_CONTROL'|'WRITE'|'READ'
            },
        ]
    }
    参数名称 参数描述 类型
    Owner 对象拥有者的信息,包括 DisplayName 和 ID Dict
    Grant 对象权限被授予者的信息,包括 Grantee 和 Permission List
    Grantee 对象权限被授予者的信息,包括 DisplayName,Type,ID 和 URI Dict
    DisplayName 权限被授予者的名称 String
    Type 权限被授予者的类型,类型为 CanonicalUser 或者 Group String
    ID Type 为 CanonicalUser 时,对应权限被授予者的 ID String
    URI Type 为 Group 时,对应权限被授予者的 URI String
    Permission 指明授予被授权者的权限信息,可选值有 FULL_CONTROL,WRITE,READ,分别对应所有权限、写权限、读权限 String

    Was this page helpful?

    本页内容是否解决了您的问题?

    • 完全没帮助
    • 文档较差
    • 文档一般
    • 文档不错
    • 文档很好
    反馈
    帮助