tencent cloud

文档反馈

对象访问 URL

最后更新时间:2024-01-22 11:23:32

    简介

    本文档提供获取已上传到存储的对象访问 URL 的代码示例。

    获取对象访问 URL

    功能说明

    查询对象访问的 URL,该接口不会判断对象是否真实存在。
    说明
    如何使生成的对象 URL 在浏览器中打开是预览,而不是下载:在获取的 url 后拼接参数 response-content-disposition=inline。
    如何使生成的对象 URL 在浏览器中打开是下载,而不是预览:在获取的 url 后拼接参数 response-content-disposition=attachment。
    下载时如何重命名文件:在获取的 URL 后拼接参数 filename,例如 response-content-disposition=attachment;filename=自定义文件名。
    若使用临时密钥生成预签名 URL,请确保申请临时密钥的 action 添加了 "name/cos:GetObject" 权限。

    使用示例

    获取在浏览器默认下载的 url:
    cos.getObjectUrl(
    {
    Bucket: 'examplebucket-1250000000', // 填入您自己的存储桶,必须字段
    Region: 'COS_REGION', // 存储桶所在地域,例如 ap-beijing,必须字段
    Key: '头像.jpg', // 存储在桶里的对象键(例如1.jpg,a/b/test.txt),支持中文,必须字段
    Sign: true, // 获取带签名的对象 URL
    
    },
    function (err, data) {
    if (err) return console.log(err);
    /* url为对象访问 url */
    var url = data.Url;
    /* 复制 downloadUrl 的值到浏览器打开会自动触发下载 */
    var downloadUrl =
    data.Url +
    (data.Url.indexOf('?') > -1 ? '&' : '?') +
    'response-content-disposition=attachment;filename=图片.jpg'; // 补充强制下载的参数并重命名下载后的文件
    }
    );

    参数说明

    参数名
    参数描述
    类型
    是否必填
    Bucket
    存储桶的名称,命名规则为 BucketName-APPID,此处填写的存储桶名称必须为此格式
    String
    Region
    存储桶所在地域,枚举值请参见 地域和访问域名
    String
    Key
    对象键(Object 的名称),对象在存储桶中的唯一标识,详情请参见 对象概述
    String
    Sign
    是否返回带有签名的 Url,默认为 true,当对象为私有读时,获取到不带签名的 url 依然没有权限访问
    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

    回调函数说明

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

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持