tencent cloud

文档反馈

防盗链

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

    简介

    本文档提供关于存储桶 Referer 白名单或者黑名单的 API 概览以及 SDK 示例代码。
    注意
    需要 COS PYTHON SDK v5.1.9.7 及以上版本。
    API
    操作名
    操作描述
    设置存储桶 Referer
    设置存储桶 Referer 白名单或者黑名单
    查询存储桶 Referer
    查询存储桶 Referer 白名单或者黑名单

    设置存储桶 Referer

    功能说明

    设置指定存储桶的 Referer 白名单或者黑名单(PUT Bucket referer)。

    方法原型

    put_bucket_referer(Bucket, RefererConfiguration, **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)
    
    referer_config = {
    'Status': 'Enabled',
    'RefererType': 'White-List',
    'EmptyReferConfiguration': 'Allow',
    'DomainList': {
    'Domain': [
    '*.qq.com',
    '*.qcloud.com'
    ]
    }
    }
    response = client.put_bucket_referer(
    Bucket='examplebucket-1250000000',
    RefererConfiguration=referer_config
    )

    参数说明

    参数名
    参数描述
    类型
    bucketName
    存储桶的命名格式为 BucketName-APPID,详情请参见 命名规范
    String
    RefererConfiguration
    存储桶 Referer 配置
    Dict
    RefererConfiguration 说明:
    参数名
    参数描述
    类型
    是否必填
    Status
    是否开启防盗链,枚举值:Enabled、Disabled
    String
    RefererType
    防盗链类型,枚举值:Black-List、White-List
    String
    DomainList
    生效域名的列表
    Dict
    Domain
    生效域名,支持带端口和 IP、支持通配符*, 支持多条
    List
    EmptyReferConfiguration
    是否允许空 Refer 访问,枚举值: Allow、Deny
    String

    返回结果说明

    该方法返回值为 None。

    查询存储桶 Referer

    功能说明

    查询指定存储桶 Referer 白名单或者黑名单(GET Bucket referer)。

    方法原型

    get_bucket_referer(Bucket, **kwargs)

    请求示例

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

    参数说明

    参数名
    参数描述
    类型
    bucketName
    存储桶的命名格式为 BucketName-APPID,详情请参见 命名规范
    String

    返回结果说明

    返回存储桶的 Referer 配置,参见 RefererConfiguration 说明。

    删除存储桶 Referer

    功能说明

    删除指定存储桶 Referer 白名单或者黑名单(DELETE Bucket referer)。

    方法原型

    delete_bucket_referer(Bucket, **kwargs)

    请求示例

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

    参数说明

    参数名
    参数描述
    类型
    bucketName
    存储桶的命名格式为 BucketName-APPID,详情请参见 命名规范
    String

    返回结果说明

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

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

    技术支持

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

    7x24 电话支持