tencent cloud

All product documents
Cloud Object Storage
DocumentationCloud Object StorageSDK DocumentationMini Program SDKCloud Access ManagementHotlink Protection
Hotlink Protection
Download PDF
Last updated: 2024-02-04 17:20:25
Hotlink Protection
Last updated: 2024-02-04 17:20:25
Download PDF

Overview

This document provides an overview of APIs and SDK code samples related to bucket referer allowlist or blocklist.
API
Operation
Description
Setting bucket referer configuration
Sets a bucket referer allowlist or blocklist
Querying bucket referer configuration
Queries a bucket referer allowlist or blocklist

Setting Bucket Referer Configuration

Description

This API (PUT Bucket referer) is used to set a referer allowlist/blocklist for a bucket.

Sample request

cos.putBucketReferer({
    Bucket: 'examplebucket-1250000000', /* Required */
    Region: 'COS_REGION',     /* Bucket region. Required */
    RefererConfiguration: {
        Status: 'Enabled',
        RefererType: 'White-List',
        DomainList: {
            Domains: [
                '*.qq.com',
                '*.qcloud.com',
            ]
        },
        EmptyReferConfiguration: 'Allow',
    }
}, function(err, data) {
    console.log(err || data);
});

Parameter description

Parameter
Description
Type
Required
Bucket
Bucket for which the bucket policy is configured in the format: BucketName-APPID
String
Yes
Region
Bucket region. For the enumerated values, see Regions and Access Domain Names
String
Yes
RefererConfiguration
Hotlink protection configuration. For details, see PUT Bucket referer
Object
Yes
- Status
Whether to enable hotlink protection. Enumerated values: Enabled, Disabled
String
Yes
- RefererType
Hotlink protection type. Enumerated values: Black-List, White-List
String
Yes
- DomainList
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.
Object
Yes
- - Domains
Domain names in the blocklist/allowlist. Format: '*.qq.com' (one domain); ['*.qq.com', '*.qcloud.com'] (multiple domains)
String\Array
Yes
- EmptyReferConfiguration
Whether to allow access with an empty referer. Enumerated values: Allow, Deny (default)
String
No

Callback function description

function(err, data) { ... }
Parameter
Description
Type
err
Object returned when an error (network error or service error) occurs. If the request is successful, this is null. For more information, see Error Codes
Object
- statusCode
HTTP status code, such as 200, 403, and 404
Number
- headers
Headers
Object
data
Content returned when the request is successful. If the request fails, this parameter is empty.
Object
- statusCode
HTTP status code, such as 200, 403, and 404
Number
- headers
Headers
Object

Querying Bucket Referer Configuration

Description

This API (GET Bucket referer) is used to query the referer allowlist/blocklist of a bucket.

Sample request

cos.getBucketReferer({
    Bucket: 'examplebucket-1250000000', /* Required */
    Region: 'COS_REGION',     /* Bucket region. Required */
}, function(err, data) {
    console.log(err || data);
});

Sample response

{
    "RefererConfiguration": {
        "Status": "Enabled",
        "RefererType": "White-List",
        "DomainList": {
            "Domains": [
                "*.qq.com",
                "*.qcloud.com"
            ]
        },
        "EmptyReferConfiguration": "Allow"
    },
    "statusCode": 200,
    "headers": {},
}

Parameter description

Parameter
Description
Type
Required
Bucket
Bucket for which the bucket policy is queried in the format: BucketName-APPID
String
Yes
Region
Bucket region. For the enumerated values, please see Regions and Access Endpoints.
String
Yes

Callback function description

function(err, data) { ... }
Parameter
Description
Type
err
Object returned when an error (network error or service error) occurs. If the request is successful, this parameter is empty. For more information, please see Error Codes.
Object
data
Content returned when the request is successful. If the request fails, this parameter is empty.
Object
- RefererConfiguration
Hotlink protection configuration. For details, see GET Bucket referer
Object
- - Status
Whether hotlink protection is enabled. Enumerated values: Enabled, Disabled
String
- - RefererType
Hotlink protection type. Enumerated values: Black-List, White-List
String
- - DomainList
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.
Object
- - - Domains
Domain names in the blocklist/allowlist
Array
- - EmptyReferConfiguration
Whether access with an empty referer is allowed. Enumerated values: Allow, Deny (default)
String
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon