tencent cloud

All product documents
Cloud Object Storage
Object Access URL
Last updated: 2024-02-04 11:37:31
Object Access URL
Last updated: 2024-02-04 11:37:31

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

Parameter
Description
Type
Required
Bucket
Bucket name in the format of BucketName-APPID. The bucket name entered here must be in this format.
String
Yes
Region
Bucket region. For the enumerated values, see Regions and Access Endpoints.
String
Yes
Key
Object key (object name), which is the unique identifier of an object in a bucket. For more information, 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
Valid values: http: (default value), https:.
String
No
Domain
Bucket access domain name. 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 be included in the signature in the format of {key: 'val'}
Object
No
Headers
Request headers to be included in the signature in the format of {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
The object returned when an error (network error or service error) occurs. If the request is successful, this parameter is empty. For more information, see Error Codes.
Object
data
The object returned when the request is successful. If an error occurs with the request, this parameter is empty.
Object
- Url
Calculated URL
String

Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

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
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon