获取文件的下载地址
更新时间 2026-04-28 18:52:51
最近更新时间: 2026-04-28 18:52:51
接口描述
根据文件ID获取文件的下载地址
请求方法
POST
接口要求
无
URI
/openapi/v1/documents/preSignedUrl
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
| tenantId | 是 | String | 租户ID | abcb82293b1a40e1b97ea05e50dd8170 | |
| ctyun-eop-request-id | 是 | String | 用户请求 id,由用户构造,用户可以通过 uuid 等方法自行生成唯一字符串,用于日志请求追踪。 | abcfa732-b27b-464f-b15a-21ed6845afd5 | |
| eop-date | 是 | String | 请求时间,由用户构造,形如 yyyymmddTHHMMSSZ。 | 20211221T163014Z | |
| host | 是 | String | 终端节点域名,固定字段 | koa-global.ctapi.ctyun.cn | |
| Eop-Authorization | 是 | String | 由天翼云官网 accessKey 和 securityKey 经签名后生成,参与签名生成的字段包括天翼云官网 accessKey 、securityKey、用户请求id(非必须),请求时间,终端节点域名(非必须)以及请求体内容。 |
请求Body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
| fileId | 是 | Int | 文件ID,即知识库文档的infobasefileId | 234 |
请求代码示例
Curl -X GET "https://kqa-global.ctapi.ctyun.cn/openapi/v1/documents/preSignedUrl"
-H "ctyun-eop-request-id:33dfa732-b27b-464f-b15a-21ed6845afd5"
-H "tenantId:XXX"
-H "Eop-Authorization:XXX"
-H "eop-date:20211109T104641Z"
-H "host:kqa-global.ctapi.ctyun.cn"
--data-raw '{
"fileId": 234
}'返回值说明
1.请求成功返回响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
| statusCode | String | 200表示成功 | 200 | |
| message | String | 固定为Success | Success | |
| returnObj | Boolean | 是否执行成功 | true | returnObj对象 |
returnObj对象
| 字段 | 字段类型 | 说明 | 示例 | 下级对象 |
| fileId | Int | 文件ID,即知识库文档infobasefileId | 234 | |
infoBaseId
| Int | 知识库ID | 433 | |
| fileType | String | 文件类型 | "pdf" | |
| preSignedUrl | String | 文件下载地址,预签名地址有效期3天 | "https://xxx" |
2.请求失败返回响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
| statusCode | String | 错误码,放置API对应的错误码 | 40001 | |
| message | String | 失败信息 | 缺少鉴权信息 | |
| error | String | 返回对应的错误码 | KQA_40001 |
返回值示例
1.请求成功返回值示例
{
"statusCode": 200,
"error": null,
"message": "Success",
"returnObj": {
"infoBaseId": 433,
"fileId": 234,
"preSignedUrl": "https://xxxx",
"fileType": "pdf"
}
}2.请求失败返回值示例
{
"statusCode": "40004",
"error": "KQA_40004",
"message": "接口执行异常"
}状态码
| http状态码 | 描述 |
| 200 | 表示请求成功 |
错误码说明
见6.1.3通用错误码