tencent cloud

Cloud Object Storage

Release Notes and Announcements
Release Notes
Announcements
Product Introduction
Overview
Features
Use Cases
Strengths
Concepts
Regions and Access Endpoints
Specifications and Limits
Service Regions and Service Providers
Billing
Billing Overview
Billing Method
Billable Items
Free Tier
Billing Examples
Viewing and Downloading Bill
Payment Overdue
FAQs
Getting Started
Console
Getting Started with COSBrowser
User Guide
Creating Request
Bucket
Object
Data Management
Batch Operation
Global Acceleration
Monitoring and Alarms
Operations Center
Data Processing
Content Moderation
Smart Toolbox
Data Processing Workflow
Application Integration
User Tools
Tool Overview
Installation and Configuration of Environment
COSBrowser
COSCLI (Beta)
COSCMD
COS Migration
FTP Server
Hadoop
COSDistCp
HDFS TO COS
GooseFS-Lite
Online Tools
Diagnostic Tool
Use Cases
Overview
Access Control and Permission Management
Performance Optimization
Accessing COS with AWS S3 SDK
Data Disaster Recovery and Backup
Domain Name Management Practice
Image Processing
Audio/Video Practices
Workflow
Direct Data Upload
Content Moderation
Data Security
Data Verification
Big Data Practice
COS Cost Optimization Solutions
Using COS in the Third-party Applications
Migration Guide
Migrating Local Data to COS
Migrating Data from Third-Party Cloud Storage Service to COS
Migrating Data from URL to COS
Migrating Data Within COS
Migrating Data Between HDFS and COS
Data Lake Storage
Cloud Native Datalake Storage
Metadata Accelerator
GooseFS
Data Processing
Data Processing Overview
Image Processing
Media Processing
Content Moderation
File Processing Service
File Preview
Troubleshooting
Obtaining RequestId
Slow Upload over Public Network
403 Error for COS Access
Resource Access Error
POST Object Common Exceptions
API Documentation
Introduction
Common Request Headers
Common Response Headers
Error Codes
Request Signature
Action List
Service APIs
Bucket APIs
Object APIs
Batch Operation APIs
Data Processing APIs
Job and Workflow
Content Moderation APIs
Cloud Antivirus API
SDK Documentation
SDK Overview
Preparations
Android SDK
C SDK
C++ SDK
.NET(C#) SDK
Flutter SDK
Go SDK
iOS SDK
Java SDK
JavaScript SDK
Node.js SDK
PHP SDK
Python SDK
React Native SDK
Mini Program SDK
Error Codes
Harmony SDK
Endpoint SDK Quality Optimization
Security and Compliance
Data Disaster Recovery
Data Security
Cloud Access Management
FAQs
Popular Questions
General
Billing
Domain Name Compliance Issues
Bucket Configuration
Domain Names and CDN
Object Operations
Logging and Monitoring
Permission Management
Data Processing
Data Security
Pre-signed URL Issues
SDKs
Tools
APIs
Agreements
Service Level Agreement
Privacy Policy
Data Processing And Security Agreement
Contact Us
Glossary

Object Access URL

PDF
Mode fokus
Ukuran font
Terakhir diperbarui: 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


Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan