tencent cloud

文档反馈

防盗链

最后更新时间:2022-01-17 12:46:50

    简介

    本文档提供关于存储桶 Referer 白名单或者黑名单的 API 概览以及 SDK 示例代码。

    注意:

    需要 COS PYTHON SDK v5.1.9.7 及以上版本。

    API 操作名 操作描述
    PUT Bucket referer 设置存储桶 Referer 设置存储桶 Referer 白名单或者黑名单
    GET Bucket 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 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 = 'SecretId'     # 替换为用户的 SecretId,请登录访问管理控制台进行查看和管理,https://console.intl.cloud.tencent.com/cam/capi
    secret_key = 'SecretKey'   # 替换为用户的 SecretKey,请登录访问管理控制台进行查看和管理,https://console.intl.cloud.tencent.com/cam/capi
    region = 'ap-beijing'      # 替换为用户的 region,已创建桶归属的region可以在控制台查看,https://console.intl.cloud.tencent.com/cos5/bucket
                             # COS支持的所有region列表参见https://intl.cloud.tencent.com/document/product/436/6224
    token = None               # 如果使用永久密钥不需要填入token,如果使用临时密钥需要填入,临时密钥生成和使用指引参见https://intl.cloud.tencent.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 电话支持