tencent cloud

对象存储

动态与公告
产品动态
产品公告
产品简介
产品概述
功能概览
应用场景
产品优势
基本概念
地域和访问域名
规格与限制
产品计费
计费概述
计费方式
计费项
免费额度
计费示例
查看和下载账单
欠费说明
常见问题
快速入门
控制台快速入门
COSBrowser 快速入门
用户指南
创建请求
存储桶
对象
数据管理
批量处理
全球加速
监控与告警
运维中心
数据处理
内容审核
智能工具箱
数据工作流
应用集成
工具指南
工具概览
环境安装与配置
COSBrowser 工具
COSCLI 工具
COSCMD 工具
COS Migration 工具
FTP Server 工具
Hadoop 工具
COSDistCp 工具
HDFS TO COS 工具
GooseFS-Lite 工具
在线辅助工具
自助诊断工具
实践教程
概览
访问控制与权限管理
性能优化
使用 AWS S3 SDK 访问 COS
数据容灾备份
域名管理实践
图片处理实践
COS 音视频播放器实践
工作流实践
数据直传
内容审核实践
数据安全
数据校验
大数据实践
COS 成本优化解决方案
在第三方应用中使用 COS
迁移指南
本地数据迁移至 COS
第三方云存储数据迁移至 COS
以 URL 作为源地址的数据迁移至 COS
COS 之间数据迁移
Hadoop 文件系统与 COS 之间的数据迁移
数据湖存储
云原生数据湖
元数据加速
数据加速器 GooseFS
数据处理
数据处理概述
图片处理
媒体处理
内容审核
文件处理
文档处理
故障处理
获取 RequestId 操作指引
通过外网上传文件至 COS 缓慢
访问 COS 时返回403错误码
资源访问异常
POST Object 常见异常
API 文档
简介
公共请求头部
公共响应头部
错误码
请求签名
操作列表
Service 接口
Bucket 接口
Object 接口
批量处理接口
数据处理接口
任务与工作流
内容审核接口
云查毒接口
SDK 文档
SDK 概览
准备工作
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
小程序 SDK
错误码
鸿蒙(Harmony) SDK
终端 SDK 质量优化
安全与合规
数据容灾
数据安全
访问管理
常见问题
热门问题
一般性问题
计费计量问题
域名合规问题
存储桶配置问题
域名和 CDN 问题
文件操作问题
日志监控问题
权限管理问题
数据处理问题
数据安全问题
预签名 URL 问题
SDK 类问题
工具类问题
API 类问题
服务协议
Service Level Agreement
隐私政策
数据处理和安全协议
联系我们
词汇表

生成预签名 URL

PDF
聚焦模式
字号
最后更新时间: 2024-11-21 16:40:46

简介

JavaScript SDK 提供获取对象 URL、获取请求预签名 URL 接口。
说明:
建议用户使用临时密钥生成预签名,通过临时授权的方式进一步提高预签名上传、下载等请求的安全性。申请临时密钥时,请遵循 最小权限指引原则,防止泄漏目标存储桶或对象之外的资源。申请临时密钥的 action 需添加 "name/cos:GetObject" 权限。
如果您一定要使用永久密钥来生成预签名,建议永久密钥的权限范围仅限于上传或下载操作,以规避风险。

计算签名

COS XML API 的请求里,私有资源操作都需要鉴权凭证 Authorization,用于判断当前请求是否合法。
鉴权凭证使用方式有两种:
1. 放在 header 参数里使用,字段名:authorization。
2. 放在 url 参数里使用,字段名:sign。
COS.getAuthorization 方法用于计算鉴权凭证(Authorization),用以验证请求合法性的签名信息。
注意:
该方法推荐只在前端调试时使用,项目上线不推荐使用前端计算签名的方法,有暴露密钥的风险。

使用示例

获取对象下载的鉴权凭证:
// SECRETID 和 SECRETKEY 请登录 https://console.tencentcloud.com/cam/capi 进行查看和管理
var Authorization = COS.getAuthorization({
SecretId: 'SECRETID', // 用户的 SecretId,建议使用子账号密钥,授权遵循最小权限指引,降低使用风险。子账号密钥获取可参见 https://www.tencentcloud.com/document/product/598/37140?from_cn_redirect=1
SecretKey: 'SECRETKEY', // 用户的 SecretKey,建议使用子账号密钥,授权遵循最小权限指引,降低使用风险。子账号密钥获取可参见 https://www.tencentcloud.com/document/product/598/37140?from_cn_redirect=1
Method: 'get',
Key: 'exampleobject',
Expires: 60,
Query: {},
Headers: {},
});

参数说明

参数名
参数描述
类型
是否必填
SecretId
用户的 SecretId
String
SecretKey
用户的 SecretKey
String
Method
操作方法,例如 GET,POST,DELETE,HEAD 等 HTTP 方法
String
Key
对象键(Object 的名称),对象在存储桶中的唯一标识,如果请求操作是对文件的,则为文件名,且为必须参数。如果操作是对于存储桶,则为空
String
Query
签名中要签入的请求参数,{key: 'val'} 的格式
Object
Headers
签名中要签入的请求头部,{key: 'val'} 的格式
Object
Expires
签名几秒后失效,默认为 900 秒
Number

返回值说明

返回值是计算得到的鉴权凭证字符串 authorization。

获取请求预签名 URL

下载请求示例

示例一:获取不带签名的对象的 Url。
var url = cos.getObjectUrl({
Bucket: 'examplebucket-1250000000', /* 填入您自己的存储桶,必须字段 */
Region: 'COS_REGION', /* 存储桶所在地域,例如 ap-beijing,必须字段 */
Key: '头像.jpg', /* 存储在桶里的对象键(例如1.jpg,a/b/test.txt),支持中文,必须字段 */
Sign: false,
});
示例二:获取带签名的对象的 Url。
var url = cos.getObjectUrl({
Bucket: 'examplebucket-1250000000', /* 填入您自己的存储桶,必须字段 */
Region: 'COS_REGION', /* 存储桶所在地域,例如 ap-beijing,必须字段 */
Key: '头像.jpg', /* 存储在桶里的对象键(例如1.jpg,a/b/test.txt),支持中文,必须字段 */
});
示例三:通过 callback 获取带签名 Url。
说明:
如果签名过程是异步获取,需要通过 callback 获取带签名 Url。
cos.getObjectUrl(
{
Bucket: 'examplebucket-1250000000', /* 填入您自己的存储桶,必须字段 */
Region: 'COS_REGION', /* 存储桶所在地域,例如 ap-beijing,必须字段 */
Key: '头像.jpg', /* 存储在桶里的对象键(例如1.jpg,a/b/test.txt),支持中文,必须字段 */
Sign: false,
},
function (err, data) {
console.log(err || data.Url);
}
);
示例四:指定链接有效时间。
cos.getObjectUrl(
{
Bucket: 'examplebucket-1250000000', /* 填入您自己的存储桶,必须字段 */
Region: 'COS_REGION', /* 存储桶所在地域,例如 ap-beijing,必须字段 */
Key: '头像.jpg', /* 存储在桶里的对象键(例如1.jpg,a/b/test.txt),支持中文,必须字段 */
Sign: true,
Expires: 3600, // 单位秒
},
function (err, data) {
console.log(err || data.Url);
}
);
示例五:获取对象的 Url 并下载对象。
cos.getObjectUrl(
{
Bucket: 'examplebucket-1250000000', /* 填入您自己的存储桶,必须字段 */
Region: 'COS_REGION', /* 存储桶所在地域,例如 ap-beijing,必须字段 */
Key: '头像.jpg', /* 存储在桶里的对象键(例如1.jpg,a/b/test.txt),支持中文,必须字段 */
Sign: true,
},
function (err, data) {
if (err) return console.log(err);
var downloadUrl =
data.Url +
(data.Url.indexOf('?') > -1 ? '&' : '?') +
'response-content-disposition=attachment'; // 补充强制下载的参数
/* 可拼接 filename 来实现下载时重命名 */
/* downloadUrl += ';filename=myname'; */
// (推荐使用 window.open()方式)这里是新窗口打开 url,如果需要在当前窗口打开,可以使用隐藏的 iframe 下载,或使用 a 标签 download 属性协助下载
window.open(downloadUrl);
}
);
示例六:生成预签名 URL,并在签名中携带 Query 和 Header。
cos.getObjectUrl(
{
Bucket: 'examplebucket-1250000000', /* 填入您自己的存储桶,必须字段 */
Region: 'COS_REGION', /* 存储桶所在地域,例如 ap-beijing,必须字段 */
Key: '头像.jpg', /* 存储在桶里的对象键(例如1.jpg,a/b/test.txt),支持中文,必须字段 */
Sign: true,
/* 传入的请求参数需与实际请求相同,能够防止用户篡改此 HTTP 请求的参数 */
Query: {
'imageMogr2/thumbnail/200x/': '',
},
/* 传入的请求头部需包含在实际请求中,能够防止用户篡改签入此处的 HTTP 请求头部 */
Headers: {
host: 'xxx', /* 指定 host 访问,非指定的 host 访问会报错403 */
},
},
function (err, data) {
console.log(err || data.Url);
}
);

上传请求示例

示例一:获取预签名 Put Object 上传 Url。
cos.getObjectUrl(
{
Bucket: 'examplebucket-1250000000', /* 填入您自己的存储桶,必须字段 */
Region: 'COS_REGION', /* 存储桶所在地域,例如 ap-beijing,必须字段 */
Key: '头像.jpg', /* 存储在桶里的对象键(例如1.jpg,a/b/test.txt),支持中文,必须字段 */
Method: 'PUT',
Sign: true,
},
function (err, data) {
if (err) return console.log(err);
console.log(data.Url);

/* 获取到 Url 后,前端可以这样 ajax 上传 */
var xhr = new XMLHttpRequest();
xhr.open('PUT', data.Url, true); /* PUT 和 getObjectUrl 填写的 Method 对应 */
xhr.onload = function (e) {
console.log('上传成功', xhr.status, xhr.statusText);
};
xhr.onerror = function (e) {
console.log('上传出错', xhr.status, xhr.statusText);
};
xhr.send(file); /* file 是要上传的文件对象 */
}
);

参数说明

参数名
参数描述
类型
是否必填
Bucket
存储桶的名称,命名规则为 BucketName-APPID,此处填写的存储桶名称必须为此格式
String
Region
存储桶所在地域,枚举值请参见 地域和访问域名
String
Key
对象键(Object 的名称),对象在存储桶中的唯一标识,如果请求操作是对文件的,则为文件名,且为必须参数。如果操作是对于存储桶,则为空
String
Sign
是否返回带有签名的 Url,默认为 true
Boolean
Protocol
可选填为 http:https:,默认为 http:(带冒号)
String
Domain
存储桶访问域名,默认为 {BucketName-APPID}.cos.{Region}.myqcloud.com
String
Method
操作方法,例如 GET,POST,DELETE,HEAD 等 HTTP 方法,默认为 GET
String
Query
签名中要签入的请求参数,{key: 'val'} 的格式
Object
Headers
签名中要签入的请求头部,{key: 'val'} 的格式
Object
Expires
签名几秒后失效,默认为 900 秒
Number

返回值说明

返回值是一个字符串,有以下两种情况:
1. 如果签名计算可以同步计算(例如,实例化传入了 SecretId 和 SecretKey),则默认返回带签名的 Url。
2. 否则返回不带签名的 Url。

回调函数说明

function(err, data) { ... }
参数名
参数描述
类型
err
请求发生错误时返回的对象,包括网络错误和业务错误。如果请求成功则为空,详情请参见 错误码 文档
Object
data
请求成功时返回的对象,如果请求发生错误,则为空
Object
- Url
计算得到的 Url
String

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈