tencent cloud

Overview

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

Getting an Object Access URL

Feature description

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

Note：

• 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.
• To rename a file during download, concatenate the filename=(custom file name) parameter to the end of the obtained URL.
• If you use a temporary key to generate a pre-signed URL, make sure that the "name/cos:GetObject" permission has been added to the action for applying for a temporary key.

Sample code

Getting the download URL:

cos.getObjectUrl(
{
  Bucket: 'examplebucket-1250000000', /* Your bucket name. Required. */
  Region: 'COS_REGION', /* Bucket region (required), such as ap-beijing */
  Key: 'Profile photo.jpg', /* Object key stored in the bucket (required), such as `1.jpg` and `a/b/test.txt`. */
  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 =
    data.Url +
    (data.Url.indexOf('?') > -1 ? '&' : '?') +
    'response-content-disposition=attachment'; // Add the parameter for a forced download
}
);

Parameter description

Callback function description

function(err, data) { ... }