tencent cloud

Cloud Object Storage

Release Notes and Announcements
Release Notes
Announcements
Product Introduction
Overview
Features
Use Cases
Strengths
Concepts
Regions and Access Endpoints
Specifications and Limits
Service Regions and Service Providers
Billing
Billing Overview
Billing Method
Billable Items
Free Tier
Billing Examples
Viewing and Downloading Bill
Payment Overdue
FAQs
Getting Started
Console
Getting Started with COSBrowser
User Guide
Creating Request
Bucket
Object
Data Management
Batch Operation
Global Acceleration
Monitoring and Alarms
Operations Center
Data Processing
Content Moderation
Smart Toolbox
Data Processing Workflow
Application Integration
User Tools
Tool Overview
Installation and Configuration of Environment
COSBrowser
COSCLI (Beta)
COSCMD
COS Migration
FTP Server
Hadoop
COSDistCp
HDFS TO COS
GooseFS-Lite
Online Tools
Diagnostic Tool
Use Cases
Overview
Access Control and Permission Management
Performance Optimization
Accessing COS with AWS S3 SDK
Data Disaster Recovery and Backup
Domain Name Management Practice
Image Processing
Audio/Video Practices
Workflow
Direct Data Upload
Content Moderation
Data Security
Data Verification
Big Data Practice
COS Cost Optimization Solutions
Using COS in the Third-party Applications
Migration Guide
Migrating Local Data to COS
Migrating Data from Third-Party Cloud Storage Service to COS
Migrating Data from URL to COS
Migrating Data Within COS
Migrating Data Between HDFS and COS
Data Lake Storage
Cloud Native Datalake Storage
Metadata Accelerator
GooseFS
Data Processing
Data Processing Overview
Image Processing
Media Processing
Content Moderation
File Processing Service
File Preview
Troubleshooting
Obtaining RequestId
Slow Upload over Public Network
403 Error for COS Access
Resource Access Error
POST Object Common Exceptions
API Documentation
Introduction
Common Request Headers
Common Response Headers
Error Codes
Request Signature
Action List
Service APIs
Bucket APIs
Object APIs
Batch Operation APIs
Data Processing APIs
Job and Workflow
Content Moderation APIs
Cloud Antivirus API
SDK Documentation
SDK Overview
Preparations
Android SDK
C SDK
C++ SDK
.NET(C#) SDK
Flutter SDK
Go SDK
iOS SDK
Java SDK
JavaScript SDK
Node.js SDK
PHP SDK
Python SDK
React Native SDK
Mini Program SDK
Error Codes
Harmony SDK
Endpoint SDK Quality Optimization
Security and Compliance
Data Disaster Recovery
Data Security
Cloud Access Management
FAQs
Popular Questions
General
Billing
Domain Name Compliance Issues
Bucket Configuration
Domain Names and CDN
Object Operations
Logging and Monitoring
Permission Management
Data Processing
Data Security
Pre-signed URL Issues
SDKs
Tools
APIs
Agreements
Service Level Agreement
Privacy Policy
Data Processing And Security Agreement
Contact Us
Glossary

Hotlink Protection

PDF
Focus Mode
Font Size
Last updated: 2024-02-02 16:51:03

Overview

This document provides an overview of APIs and SDK code samples related to bucket referer allowlist or blocklist.
Note:
COS Java SDK v5.6.52 or later is required.
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.

Method prototype

public void setBucketRefererConfiguration(String bucketName, BucketRefererConfiguration configuration) throws CosClientException, CosServiceException;

public void setBucketRefererConfiguration(SetBucketRefererConfigurationRequest setBucketRefererConfigurationRequest) throws CosClientException, CosServiceException;

Sample request

// Source bucket name, including appid
String bucketName = "examplebucket-1250000000";

BucketRefererConfiguration configuration = new BucketRefererConfiguration();

// Enable hotlink protection
configuration.setStatus(BucketRefererConfiguration.DISABLED);
// Set the hotlink protection type to allowlist
//configuration.setRefererType(BucketRefererConfiguration.WHITELIST);
// Set the hotlink protection type to blocklist (either allowlist or blocklist)
configuration.setRefererType(BucketRefererConfiguration.BLACKLIST);

// Enter the domain name to be set
configuration.addDomain("test.com");
configuration.addDomain("test.1.com");

// (Optional) Set whether to allow access with an empty referer (default value: DENY)
configuration.setEmptyReferConfiguration(BucketRefererConfiguration.DENY);
// configuration.setEmptyReferConfiguration(BucketRefererConfiguration.ALLOW);

cosClient.setBucketRefererConfiguration(bucketName, configuration);

Parameter description

Parameter
Description
Type
bucketName
Bucket name in the format of BucketName-APPID. For details, see Naming Conventions
String
configuration
Referer configuration of a bucket
BucketRefererConfiguration
BucketRefererConfiguration description:
Parameter
Description
Type
Required
Method
Status
Whether to enable hotlink protection. Enumerated values: Enabled, Disabled
String
Yes
setStatus
RefererType
Hotlink protection type. Enumerated values: Black-List, White-List
String
Yes
setRefererType
Domain
Effective domain name. Supports one or multiple domain names with port numbers and IPs. The wildcard * is also supported.
String
Yes
addDomain
EmptyReferConfiguration
Whether to allow access with an empty referer. Enumerated values: Allow, Deny
String
No
setEmptyReferConfiguration

Response description

Success: No value is returned.
Failure: If an error (such as authentication failure) occurs, the CosClientException or CosServiceException exception will be thrown. For more information, please see Troubleshooting.

Querying Bucket Referer Configuration

Description

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

Method prototype

public BucketRefererConfiguration getBucketRefererConfiguration(String bucketName) throws CosClientException, CosServiceException

Sample request

// Source bucket name, including appid
String bucketName = "examplebucket-1250000000";

BucketRefererConfiguration configuration = cosClient.getBucketRefererConfiguration(bucketName);

if (configuration == null) {
System.out.printf("bucket %s does not have referer configuration\\n", bucketName);
return;
}

System.out.printf("status: %s\\n", configuration.getStatus());
System.out.printf("referer type: %s\\n", configuration.getRefererType());
System.out.printf("empty referer config: %s\\n", configuration.getEmptyReferConfiguration());

for (String domain : configuration.getDomainList()) {
System.out.printf("domain: %s\\n", domain);
}

Parameter description

Parameter
Description
Type
bucketName
Bucket name in the format of BucketName-APPID. For details, see Naming Conventions
String

Response description

Success: The referer allowlist or blocklist of the bucket is returned.
Failure: If an error (such as authentication failure) occurs, the CosClientException or CosServiceException exception will be thrown. For more information, please see Troubleshooting.

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback