预签名 URL

最后更新时间:2020-03-13 20:43:22

    简介

    JavaScript SDK 提供获取对象 URL、获取请求预签名 URL 接口。

    计算签名

    COS XML API 的请求里,私有资源操作都需要鉴权凭证 Authorization,用于判断当前请求是否合法。

    鉴权凭证使用方式有两种:

    1. 放在 header 参数里使用,字段名:authorization。
    2. 放在 url 参数里使用,字段名:sign。

    COS.getAuthorization 方法用于计算鉴权凭证(Authorization),用以验证请求合法性的签名信息。

    该方法推荐只在前端调试时使用,项目上线不推荐使用前端计算签名的方法,有暴露密钥的风险。

    使用示例

    获取对象下载的鉴权凭证:

    var Authorization = COS.getAuthorization({
        SecretId: 'COS_SECRETID',
        SecretKey: 'COS_SECRETKEY',
        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 请求的 query 参数对象 Object
    Headers 请求的 header 参数对象 Object
    Expires 签名几秒后失效,默认为900秒 Number

    返回值说明

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

    获取请求预签名 URL

    下载请求示例

    示例一:获取不带签名的对象的 Url

    var url = cos.getObjectUrl({
        Bucket: 'examplebucket-1250000000',
        Region: 'COS_REGION',     /* 存储桶所在地域,必须字段 */
        Key: 'exampleobject',
        Sign: false
    });

    示例二:获取带签名的对象的 Url

    var url = cos.getObjectUrl({
        Bucket: 'examplebucket-1250000000',
        Region: 'COS_REGION',     /* 存储桶所在地域,必须字段 */
        Key: 'exampleobject'
    });

    示例三:通过 callback 获取带签名 Url

    如果签名过程是异步获取,需要通过 callback 获取带签名 Url。

    cos.getObjectUrl({
        Bucket: 'examplebucket-1250000000',
        Region: 'COS_REGION',     /* 存储桶所在地域,必须字段 */
        Key: 'exampleobject',
        Sign: false
    }, function (err, data) {
        console.log(err || data.Url);
    });

    示例四:指定链接有效时间

    cos.getObjectUrl({
        Bucket: 'examplebucket-1250000000',
        Region: 'COS_REGION',     /* 存储桶所在地域,必须字段 */
        Key: 'exampleobject',
        Sign: true,
        Expires: 3600, // 单位秒
    }, function (err, data) {
        console.log(err || data.Url);
    });

    示例五:获取对象的 Url 并下载对象

    cos.getObjectUrl({
        Bucket: 'examplebucket-1250000000',
        Region: 'COS_REGION',     /* 存储桶所在地域,必须字段 */
        Key: 'exampleobject',
        Sign: true
    }, function (err, data) {
        if (err) return console.log(err);
        var downloadUrl = data.Url + (data.Url.indexOf('?') > -1 ? '&' : '?') + 'response-content-disposition=attachment'; // 补充强制下载的参数
        window.open(downloadUrl); // 这里是新窗口打开 url,如果需要在当前窗口打开,可以使用隐藏的 iframe 下载,或使用 a 标签 download 属性协助下载
    });

    上传请求示例

    示例一:获取预签名 Put Object 上传 Url。

    cos.getObjectUrl({
        Bucket: 'examplebucket-1250000000',
        Region: 'COS_REGION',     /* 存储桶所在地域,必须字段 */
        Method: 'PUT',
        Key: 'exampleobject',
        Sign: true
    }, function (err, data) {
        if (err) return console.log(err);
    
        console.log(data.Url);
        var xhr = new XMLHttpRequest();
        xhr.open('PUT', data.Url, true);
        xhr.onload = function (e) {
            console.log(xhr.responseText);
        };
        xhr.onerror = function (e) {
            console.log('获取签名出错');
        };
        xhr.send();
    });

    参数说明

    参数名 参数描述 类型 必填
    Bucket 存储桶的名称,命名规则为 BucketName-APPID,此处填写的存储桶名称必须为此格式 String
    Region 存储桶所在地域,枚举值请参见 地域和访问域名 String
    Key 对象键(Object 的名称),对象在存储桶中的唯一标识,如果请求操作是对文件的,则为文件名,且为必须参数。如果操作是对于存储桶,则为空 String
    Sign 是否返回带有签名的 Url,默认为 true Boolean
    Method 操作方法,例如 GET,POST,DELETE,HEAD 等 HTTP 方法,默认为 GET String
    Query 参与签名计算的 query 参数对象 Object
    Headers 参与签名计算的 header 参数对象 Object
    Expires 签名几秒后失效,默认为900秒 Number

    返回值说明

    返回值是一个字符串,有以下两种情况:

    1. 如果签名计算可以同步计算(例如,实例化传入了 SecretId 和 SecretKey),则默认返回带签名的 Url。
    2. 否则返回不带签名的 Url。

    回调函数说明

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

    Was this page helpful?

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

    • 完全没帮助
    • 文档较差
    • 文档一般
    • 文档不错
    • 文档很好
    反馈
    帮助