tencent cloud

文档反馈

存储桶策略

最后更新时间:2024-01-22 11:43:35

    简介

    本文档提供关于存储桶策略的 API 概览以及 SDK 示例代码。
    API
    操作名
    操作描述
    设置存储桶策略
    设置指定存储桶的权限策略
    查询存储桶策略
    查询指定存储桶的权限策略
    删除存储桶策略
    删除指定存储桶的权限策略

    设置存储桶策略

    功能说明

    设置指定存储桶的权限策略(PUT Bucket policy)。

    方法原型

    put_bucket_policy(Bucket, Policy, **kwargs)

    请求示例

    # -*- coding=utf-8
    from qcloud_cos import CosConfig
    from qcloud_cos import CosS3Client
    import sys
    import os
    import logging
    
    # 正常情况日志级别使用 INFO,需要定位时可以修改为 DEBUG,此时 SDK 会打印和服务端的通信信息
    logging.basicConfig(level=logging.INFO, stream=sys.stdout)
    
    # 1. 设置用户属性, 包括 secret_id, secret_key, region 等。Appid 已在 CosConfig 中移除,请在参数 Bucket 中带上 Appid。Bucket 由 BucketName-Appid 组成
    secret_id = os.environ['COS_SECRET_ID'] # 用户的 SecretId,建议使用子账号密钥,授权遵循最小权限指引,降低使用风险。子账号密钥获取可参见 https://www.tencentcloud.com/document/product/598/32675
    secret_key = os.environ['COS_SECRET_KEY'] # 用户的 SecretKey,建议使用子账号密钥,授权遵循最小权限指引,降低使用风险。子账号密钥获取可参见 https://www.tencentcloud.com/document/product/598/32675
    region = 'ap-beijing' # 替换为用户的 region,已创建桶归属的 region 可以在控制台查看,https://console.tencentcloud.com/cos5/bucket
    # COS 支持的所有 region 列表参见 https://www.tencentcloud.com/document/product/436/6224
    token = None # 如果使用永久密钥不需要填入 token,如果使用临时密钥需要填入,临时密钥生成和使用指引参见 https://www.tencentcloud.com/document/product/436/14048
    scheme = 'https' # 指定使用 http/https 协议来访问 COS,默认为 https,可不填
    
    config = CosConfig(Region=region, SecretId=secret_id, SecretKey=secret_key, Token=token, Scheme=scheme)
    client = CosS3Client(config)
    
    response = client.put_bucket_policy(
    Bucket='examplebucket-1250000000',
    Policy={
    "Statement": [
    {
    "Principal": {
    "qcs": [
    "qcs::cam::uin/100000000001:uin/100000000011"
    ]
    },
    "Effect": "allow",
    "Action": [
    "name/cos:GetBucket"
    ],
    "Resource": [
    "qcs::cos:ap-guangzhou:uid/1250000000:examplebucket-1250000000/*"
    ],
    "condition": {
    "ip_equal": {
    "qcs:ip": "10.121.2.10/24"
    }
    }
    }
    ],
    "version": "2.0"
    }
    )

    参数说明

    参数名称
    参数描述
    类型
    是否必填
    Bucket
    存储桶名称,由 BucketName-APPID 构成
    String
    Statement
    描述一条或多条权限的详细信息
    List
    Principal
    描述策略授权的实体,详情请参见 访问策略语言概述
    Dict
    Version
    策略语法版本,默认为2.0
    String
    Effect
    有 allow(允许)和 deny(显式拒绝)两种情况
    String
    Action
    此处是指 COS API,根据需求指定一个或者一序列操作的组合或所有操作(),例如 action 为 name/cos:GetService,请注意区分英文大小写
    List
    Resource
    授权操作的具体数据,可以是任意资源、指定路径前缀的资源、指定绝对路径的资源或它们的组合
    List
    Condition
    约束条件,可以不填,具体说明请参见 condition 说明
    List

    返回结果说明

    该方法返回值为 None。

    查询存储桶策略

    功能说明

    查询指定存储桶的权限策略(GET Bucket policy)。

    方法原型

    get_bucket_policy(Bucket, **kwargs)

    请求示例

    # -*- coding=utf-8
    from qcloud_cos import CosConfig
    from qcloud_cos import CosS3Client
    import sys
    import os
    import logging
    import json
    
    # 正常情况日志级别使用 INFO,需要定位时可以修改为 DEBUG,此时 SDK 会打印和服务端的通信信息
    logging.basicConfig(level=logging.INFO, stream=sys.stdout)
    
    # 1. 设置用户属性, 包括 secret_id, secret_key, region 等。Appid 已在 CosConfig 中移除,请在参数 Bucket 中带上 Appid。Bucket 由 BucketName-Appid 组成
    secret_id = os.environ['COS_SECRET_ID'] # 用户的 SecretId,建议使用子账号密钥,授权遵循最小权限指引,降低使用风险。子账号密钥获取可参见 https://www.tencentcloud.com/document/product/598/32675
    secret_key = os.environ['COS_SECRET_KEY'] # 用户的 SecretKey,建议使用子账号密钥,授权遵循最小权限指引,降低使用风险。子账号密钥获取可参见 https://www.tencentcloud.com/document/product/598/32675
    region = 'ap-beijing' # 替换为用户的 region,已创建桶归属的 region 可以在控制台查看,https://console.tencentcloud.com/cos5/bucket
    # COS 支持的所有 region 列表参见 https://www.tencentcloud.com/document/product/436/6224
    token = None # 如果使用永久密钥不需要填入 token,如果使用临时密钥需要填入,临时密钥生成和使用指引参见 https://www.tencentcloud.com/document/product/436/14048
    scheme = 'https' # 指定使用 http/https 协议来访问 COS,默认为 https,可不填
    
    config = CosConfig(Region=region, SecretId=secret_id, SecretKey=secret_key, Token=token, Scheme=scheme)
    client = CosS3Client(config)
    
    response = client.get_bucket_policy(
    Bucket='examplebucket-1250000000',
    )
    policy = json.loads(response['Policy'])

    参数说明

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

    返回结果说明

    Bucket 存储桶策略规则,类型为 dict,该 dict 包含一条 key-value 对,其中 key 是字符串'Policy', value 是表示具体存储桶策略规则的 JSON 字符串,可以使用json.loads()将其转换为 dict:
    {
    "Statement": [
    {
    "Principal": {
    "qcs": [
    "qcs::cam::uin/100000000001:uin/100000000011"
    ]
    },
    "Effect": "allow",
    "Action": [
    "name/cos:GetBucket"
    ],
    "Resource": [
    "qcs::cos:ap-guangzhou:uid/1250000000:examplebucket-1250000000/*"
    ],
    "condition": {
    "ip_equal": {
    "qcs:ip": "10.121.2.10/24"
    }
    }
    }
    ],
    "version": "2.0"
    }
    参数名称
    参数描述
    类型
    Statement
    描述一条或多条权限的详细信息
    List
    Principal
    描述策略授权的实体,详情请参见 访问策略语言概述
    Dict
    Version
    策略语法版本,默认为2.0
    String
    Effect
    有 allow(允许)和 deny(显式拒绝)两种情况
    String
    Action
    此处是指 COS API,根据需求指定一个或者一序列操作的组合或所有操作(),例如 action 为 name/cos:GetService,请注意区分英文大小写
    List
    Resource
    授权操作的具体数据,可以是任意资源、指定路径前缀的资源、指定绝对路径的资源或它们的组合
    List
    Condition
    约束条件,可以不填,具体说明请参见 condition 说明
    List

    删除存储桶策略

    功能说明

    删除指定存储桶的存储桶策略(DELETE Bucket policy)。

    方法原型

    delete_bucket_policy(Bucket, **kwargs)

    请求示例

    # -*- coding=utf-8
    from qcloud_cos import CosConfig
    from qcloud_cos import CosS3Client
    import sys
    import os
    import logging
    
    # 正常情况日志级别使用 INFO,需要定位时可以修改为 DEBUG,此时 SDK 会打印和服务端的通信信息
    logging.basicConfig(level=logging.INFO, stream=sys.stdout)
    
    # 1. 设置用户属性, 包括 secret_id, secret_key, region等。Appid 已在 CosConfig 中移除,请在参数 Bucket 中带上 Appid。Bucket 由 BucketName-Appid 组成
    secret_id = os.environ['COS_SECRET_ID'] # 用户的 SecretId,建议使用子账号密钥,授权遵循最小权限指引,降低使用风险。子账号密钥获取可参见 https://www.tencentcloud.com/document/product/598/32675
    secret_key = os.environ['COS_SECRET_KEY'] # 用户的 SecretKey,建议使用子账号密钥,授权遵循最小权限指引,降低使用风险。子账号密钥获取可参见 https://www.tencentcloud.com/document/product/598/32675
    region = 'ap-beijing' # 替换为用户的 region,已创建桶归属的 region 可以在控制台查看,https://console.tencentcloud.com/cos5/bucket
    # COS 支持的所有 region 列表参见 https://www.tencentcloud.com/document/product/436/6224
    token = None # 如果使用永久密钥不需要填入 token,如果使用临时密钥需要填入,临时密钥生成和使用指引参见 https://www.tencentcloud.com/document/product/436/14048
    scheme = 'https' # 指定使用 http/https 协议来访问 COS,默认为 https,可不填
    
    config = CosConfig(Region=region, SecretId=secret_id, SecretKey=secret_key, Token=token, Scheme=scheme)
    client = CosS3Client(config)
    
    response = client.delete_bucket_policy(
    Bucket='examplebucket-1250000000',
    )

    参数说明

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

    返回结果说明

    该方法返回值为 None。
    联系我们

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

    技术支持

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

    7x24 电话支持