tencent cloud


Object Access URL

Last updated: 2022-01-13 12:40:59


    This document provides an overview of the API and sample code for getting an object access URL.

    Getting an Object Access URL


    This API is used to query the URL to access an object. This API does not verify whether the object exists or not.


    • To make the generated object URL a preview URL instead of a download URL, concatenate the response-content-disposition=inline parameter to the end of the obtained URL.
    • To make the generated object URL a download URL instead of a preview URL, concatenate the response-content-disposition=attachment parameter to the end of the obtained URL.

    Sample code

    Getting the download URL:

       Bucket: 'examplebucket-1250000000', /* Your bucket name. Required. */
       Region: 'COS_REGION',  /* Bucket region, such as `ap-beijing`. Required. */
       Key: '1.jpg',  /* Object key stored in the bucket (such as `1.jpg` and `a/b/test.txt`). Required. */
       Sign: true,    /* Get a signed object URL. */
    }, function(err, data) {
       if (err) return console.log(err);
       /* The URL is the object access URL. */
       var url = data.Url;
       /* Copy the value of `downloadUrl` to the browser and open it, and then download is automatically triggered. */
       var downloadUrl = url + (url.indexOf('?') > -1 ? '&' : '?') + 'response-content-disposition=attachment'; // Add the parameter for a forced download

    Parameter description

    Parameter Description Type Required
    Bucket Bucket name in the format of BucketName-APPID. String Yes
    Region Bucket region. For the enumerated values, please see Regions and Access Endpoints. String Yes
    Key Object key (object name), the unique identifier of an object in a bucket. For more information, please see Object Overview. String Yes
    Sign Whether to return a signed URL. Default value: true. If the object is configured with the private read permission, you still do not have the access permission after you obtain the unsigned URL. Boolean No
    Protocol It can be http: (default) or https: String No
    Domain Bucket access domain. Default value: {BucketName-APPID}.cos.{Region}.myqcloud.com String No
    Method HTTP request method such as GET, POST, DELETE, or HEAD. Default value: GET String No
    Query Request parameters to include in the signature. Format: {key: 'val'} Object No
    Headers Request headers to include in the signature. Format: {key: 'val'} Object No
    Expires Signature expiration time in seconds. Default value: 900 Number 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
    data Content returned when the request is successful. If the request fails, this parameter is empty. Object
    - Url Calculated URL String
    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