tencent cloud

Feedback

Cross-Origin Resource Sharing

Last updated: 2022-05-09 14:27:13

    Overview

    This document provides an overview of APIs and SDK sample codes for cross-origin resource sharing (CORS).

    For more information, see Cross-Origin Resource Sharing. When you set the CORS configuration, see Setting Cross-Origin Resource Sharing (CORS) or Setting Cross-Origin Access.

    API Operation Description
    PUT Bucket cors Setting CORS configuration Sets the CORS permissions of bucket
    GET Bucket cors Querying CORS configuration Queries the CORS configuration of a bucket
    DELETE Bucket cors Deleting CORS configuration Deletes the CORS configuration of a bucket

    Setting CORS Configuration

    Description

    This API is used to set the CORS configuration of a specified bucket.

    Method prototype

    public void setBucketCrossOriginConfiguration(String bucketName, BucketCrossOriginConfiguration bucketCrossOriginConfiguration);
    

    Sample request

    // Enter the bucket name in the format: BucketName-APPID.
    String bucketName = "examplebucket-1250000000";
    | bucketCrossOriginConfiguration | The cross-domain access rules set for a bucket | BucketCrossOriginConfiguration |
    List<CORSRule> corsRules = new ArrayList<CORSRule>();
    CORSRule corsRule = new CORSRule();
    // Rule name
    corsRule.setId("set-bucket-cors-test");
    // Allowed HTTP method
    corsRule.setAllowedMethods(CORSRule.AllowedMethods.PUT, CORSRule.AllowedMethods.GET, CORSRule.AllowedMethods.HEAD);
    corsRule.setAllowedHeaders("x-cos-grant-full-control");
    corsRule.setAllowedOrigins("http://mail.qq.com", "http://www.qq.com", "http://video.qq.com");
    corsRule.setExposedHeaders("x-cos-request-id");
    corsRule.setMaxAgeSeconds(60);
    corsRules.add(corsRule);
    bucketCORS.setRules(corsRules);
    cosClient.setBucketCrossOriginConfiguration(bucketName, bucketCORS);
    

    Parameter description

    Parameter Description Type
    bucketName Bucket name in the format of BucketName-APPID. For details, see the bucket naming conventions section in Bucket Overview. String
    bucketCrossOriginConfiguration The cross-origin access rules set for a bucket BucketCrossOriginConfiguration

    Response description

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

    Querying CORS Configuration

    Description

    This API is used to query the CORS configuration of a bucket.

    Method prototype

    public BucketCrossOriginConfiguration getBucketCrossOriginConfiguration(String bucketName)
    throws CosClientException, CosServiceException;
    

    Sample request

    // Enter the bucket name in the format: BucketName-APPID.
    String bucketName = "examplebucket-1250000000";
    BucketCrossOriginConfiguration corsGet = cosClient.getBucketCrossOriginConfiguration(bucketName);
    List<CORSRule> corsRules = corsGet.getRules();
    for (CORSRule rule : corsRules) {
       List<CORSRule.AllowedMethods> allowedMethods = rule.getAllowedMethods();
       List<String> allowedHeaders = rule.getAllowedHeaders();
       List<String> allowedOrigins = rule.getAllowedOrigins();
       List<String> exposedHeaders = rule.getExposedHeaders();
       int maxAgeSeconds = rule.getMaxAgeSeconds();
    }
    

    Parameter description

    Parameter Description Type
    bucketName Bucket name in the format of BucketName-APPID. For details, see the bucket naming conventions section in Bucket Overview. String

    Response description

    -Success: Returns the cross-origin rules for the bucket.

    • Failure: If an error (such as authentication failure) occurs, the CosClientException or CosServiceException exception will be reported. For more information, see Troubleshooting.

    Deleting CORS Configuration

    Description

    This API is used to delete the CORS configuration of a bucket.

    Method prototype

    public void deleteBucketCrossOriginConfiguration(String bucketName)
    throws CosClientException, CosServiceException;
    

    Sample request

    Bucket. Format: BucketName-APPID
    String bucketName = "examplebucket-1250000000";
    cosClient.deleteBucketCrossOriginConfiguration(bucketName);
    

    Parameter description

    Parameter Description Type
    bucketName Bucket name in the format of BucketName-APPID. For details, see the bucket naming conventions section in Bucket Overview. String

    Response description

    • Success: No value is returned.
    • Failure: If an error (such as authentication failure) occurs, the CosClientException or CosServiceException exception will be reported. For more information, see Troubleshooting.
    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