API 文档

获取下载文件信息

最近更新时间:2021-07-15 08:08:32

我的收藏

1. 接口描述

接口请求域名: tcb.tencentcloudapi.com 。

获取下载文件信息

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDownloadFile。
Version String 公共参数,本接口取值:2018-06-08。
Region String 公共参数,本接口不需要传递此参数。
CodeUri String 代码uri,格式如:extension://abcdefhhxxx.zip,对应 DescribeExtensionUploadInfo 接口的返回值

3. 输出参数

参数名称 类型 描述
FilePath String 文件路径,该字段已废弃
注意:此字段可能返回 null,表示取不到有效值。
CustomKey String 加密key,用于计算下载加密文件的header。参考SSE-C https://cloud.tencent.com/document/product/436/7728#sse-c
注意:此字段可能返回 null,表示取不到有效值。
DownloadUrl String 下载链接
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取文件下载信息

获取文件下载信息

输入示例

https://tcb.tencentcloudapi.com/?Action=DescribeDownloadFile
&CodeUri=extension://ba883a90xxxxx.zip
&<公共请求参数>

输出示例

{
  "Response": {
    "DownloadUrl": "https://cloudaccess-code-123.cos.ap-shanghai.myqcloud.com/aaa",
    "CustomKey": "xxx",
    "FilePath": "file",
    "RequestId": "d691f154-c2d5-4f48-833a-a408cdaadd9c"
  }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
LimitExceeded 超过配额限制。
MissingParameter 缺少参数错误。
目录