tencent cloud

Feedback

Hotlink Protection

Last updated: 2024-06-25 10:53:13

    Overview

    This document provides an overview of APIs and SDK code samples for hotlink protection.
    API
    Operation
    Description
    Setting hotlink protection
    Sets hotlink protection for a bucket
    Querying the hotlink protection configuration
    Queries the hotlink protection configuration of a bucket

    SDK API References

    For the parameters and method descriptions of all the APIs in the SDK, see SDK API Reference.

    Feature description

    This API (PUT Bucket referer) is used to set hotlink protection for a bucket.

    Sample code

    // Bucket name in the format of `BucketName-APPID` (`APPID` is required), which can be viewed in the COS console at https://console.tencentcloud.com/cos5/bucket.
    String bucket = "examplebucket-1250000000";
    PutBucketRefererRequest putBucketRefererRequest = new PutBucketRefererRequest(
    bucket, true, RefererConfiguration.RefererType.White);
    putBucketRefererRequest.setAllowEmptyRefer(false);
    ArrayList<RefererConfiguration.Domain> domainList = new ArrayList<>();
    domainList.add(new RefererConfiguration.Domain("*.qq.com"));
    domainList.add(new RefererConfiguration.Domain("*.qcloud.com"));
    domainList.add(new RefererConfiguration.Domain("*.google.com"));
    putBucketRefererRequest.setDomainList(domainList);
    cosXmlService.putBucketRefererAsync(putBucketRefererRequest,
    new CosXmlResultListener() {
    @Override
    public void onSuccess(CosXmlRequest request, CosXmlResult result) {
    // For detailed fields, see the API documentation or SDK source code.
    PutBucketRefererResult putBucketRefererResult =
    (PutBucketRefererResult) result;
    }
    // If you use the Kotlin language to call this, please note that the exception in the callback method is nullable; otherwise, the onFail method will not be called back, that is:
    // clientException is of type CosXmlClientException? and serviceException is of type CosXmlServiceException?
    @Override
    public void onFail(CosXmlRequest cosXmlRequest,
    @Nullable CosXmlClientException clientException,
    @Nullable CosXmlServiceException serviceException) {
    if (clientException != null) {
    clientException.printStackTrace();
    } else {
    serviceException.printStackTrace();
    }
    }
    });
    Note:
    For more complete samples, visit GitHub.

    Feature description

    This API (GET Bucket referer) is used to query the hotlink protection configuration of a bucket.

    Sample code

    // Bucket name in the format of `BucketName-APPID` (`APPID` is required), which can be viewed in the COS console at https://console.tencentcloud.com/cos5/bucket.
    String bucket = "examplebucket-1250000000";
    GetBucketRefererRequest getBucketRefererRequest = new GetBucketRefererRequest(bucket);
    cosXmlService.getBucketRefererAsync(getBucketRefererRequest,
    new CosXmlResultListener() {
    @Override
    public void onSuccess(CosXmlRequest request, CosXmlResult result) {
    // For detailed fields, see the API documentation or SDK source code.
    GetBucketRefererResult getBucketRefererResult =
    (GetBucketRefererResult) result;
    }
    // If you use the Kotlin language to call this, please note that the exception in the callback method is nullable; otherwise, the onFail method will not be called back, that is:
    // clientException is of type CosXmlClientException? and serviceException is of type CosXmlServiceException?
    @Override
    public void onFail(CosXmlRequest cosXmlRequest,
    @Nullable CosXmlClientException clientException,
    @Nullable CosXmlServiceException serviceException) {
    if (clientException != null) {
    clientException.printStackTrace();
    } else {
    serviceException.printStackTrace();
    }
    }
    });
    Note:
    For more complete samples, visit GitHub.
    Contact Us

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

    Technical Support

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

    7x24 Phone Support