tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

PUT Bucket referer

Last updated: 2024-03-28 18:08:33

    Overview

    This API is used to set the referer allowlist/blocklist for a bucket.
    

    Request

    Sample request

    PUT /?referer HTTP 1.1
    Host:<BucketName-APPID>.<Region>.myqcloud.com
    Date:GMT Date
    Authorization: Auth String
    Content-Length:length
    Content-MD5:MD5
    Note:
    In Host: <BucketName-APPID>.cos.<Region>.myqcloud.com, <BucketName-APPID> is the bucket name followed by the APPID, such as examplebucket-1250000000 (see Bucket Overview > Basic Information and Bucket Overview > Bucket Naming Conventions), and <Region> is a COS region (see Regions and Access Endpoints).
    Authorization: Auth String (See Request Signature for details.)

    Request headers

    This API only uses Common Request Headers.

    Request body

    The nodes of the request body are as follows:
    <RefererConfiguration>
      <Status>Enabled</Status>
      <RefererType>White-List</RefererType>
      <DomainList>
        <Domain>*.qq.com</Domain>
        <Domain>*.qcloud.com</Domain>
      </DomainList>
      <EmptyReferConfiguration>Allow</EmptyReferConfiguration>
    </RefererConfiguration>
    The nodes are described as follows:
    Node Name
    Parent Node
    Description
    Type
    Required
    RefererConfiguration
    None
    Hotlink protection configuration
    Container
    Yes
    Status
    RefererConfiguration
    Whether to enable hotlink protection. Enumerated values: Enabled, Disabled
    String
    Yes
    RefererType
    RefererConfiguration
    Hotlink protection type. Enumerated values: Black-List, White-List
    String
    Yes
    DomainList
    RefererConfiguration
    A list of domain names in the blocklist/allowlist. Using a prefix to specify multiple domains is supported. Domain names and IPs with ports are supported. A wildcard (*) is supported for second-level or multi-level domains.
    Container
    Yes
    Domain
    DomainList
    A single domain in the blocklist/allowlist, such as www.qq.com/example, 192.168.1.2:8080, or *.qq.com
    String
    Yes
    EmptyReferConfiguration
    RefererConfiguration
    Whether to allow access with an empty referer. Enumerated values: Allow, Deny (default)
    String
    No

    Response

    Response headers

    This API only returns Common Response Headers.

    Response body

    The response body is empty.

    Error codes

    This API returns common error responses and error codes. For more information, please see Error Codes.

    Example

    Request

    PUT /?referer HTTP 1.1
    Host: examplebucket-1250000000.cos.ap-beijing.myqcloud.com
    Date: Fri, 25 Feb 2017 04:10:22 GMT
    Authorization:q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0a1ICvR****&q-sign-time=1547105134;32526689134&q-key-time=1547105134;32620001134&q-header-list=content-md5;content-type;host&q-url-param-list=referer&q-signature=0f7fef5b1d2180deaf6f92fa2ee0cf87ae83f****
    Content-MD5: kOz7g54LMJZjxKs070V9jQ==
    Content-Type: application/xml
    
    <RefererConfiguration>
      <Status>Enabled</Status>
      <RefererType>White-List</RefererType>
      <DomainList>
        <Domain>*.qq.com</Domain>
        <Domain>*.qcloud.com</Domain>
      </DomainList>
      <EmptyReferConfiguration>Allow</EmptyReferConfiguration>
    </RefererConfiguration>

    Response

    HTTP/1.1 200 OK
    Content-Length: 0
    Connection: keep-alive
    Date: Fri, 25 Feb 2017 04:10:22 GMT
    Server: tencent-cos
    x-cos-request-id: NTg3ZjFjMmJfOWIxZjRlXzZmNDhf****
    
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy