GET Bucket Referer

Last updated: 2021-07-27 16:00:43

    Overview

    This API is used to read the referer allowlist/blocklist of a bucket.

    You are advised to use API Explorer.
    Debug
    API Explorer makes it easy to make online API calls, verify signatures, generate SDK code, search for APIs, etc. You can also use it to query the content of each request as well as its response.

    Request

    Sample request

    GET /?referer HTTP 1.1
    Host:<BucketName-APPID>.<Region>.myqcloud.com
    Date: GMT Date
    Authorization: Auth String
    
    Note:

    Authorization: Auth String (See Request Signature for details.)

    Request headers

    This API only uses common request headers. For more information, please see Common Request Headers.

    Request body

    This request has no request body.

    Response

    Response headers

    This API returns only common response headers. For more information, please see Common Response Headers.

    Response body

    This response body returns application/xml data. The following contains all the nodes:

    <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 hotlink protection is enabled. 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 accessing with an empty referer is allowed. Enumerated values: Allow, Deny (default) String No

    Error codes

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

    Sample

    Request

    GET /?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=0f7fef5b1d2180deaf6f92fa2ee0cf87ae83****
    

    Response

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Content-Length: 260
    Connection: keep-alive
    Date: Fri, 25 Feb 2017 04:10:22 GMT
    Server: tencent-cos
    x-cos-request-id: NTg3ZjFjMmJfOWIxZjRlXzZmNDhf****
    <RefererConfiguration>
    <Status>Enabled</Status>
    <RefererType>White-List</RefererType>
    <DomainList>
    <Domain>*.qq.com</Domain>
    <Domain>*.qcloud.com</Domain>
    </DomainList>
    <EmptyReferConfiguration>Allow</EmptyReferConfiguration>
    </RefererConfiguration>