1. 接口描述
接口请求域名： lke.tencentcloudapi.com 。
获取文件上传临时密钥
默认接口请求频率限制：100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeStorageCredential。 |
| Version | 是 | String | 公共参数，本接口取值：2023-11-30。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| BotBizId | 否 | String | 应用ID，参数非必填不代表不需要填写，下面不同的参数组合会获取到不同的权限，具体请参考 https://cloud.tencent.com/document/product/1759/116238 示例值：177106121651545* |
| FileType | 否 | String | 文件类型,正常的文件名类型后缀，支持 docx、doc、pdf、txt、md、wps、pages、html、mhtml、epub、xml、json、log、xlsx、xls、csv、tsv、numbers、pptx、ppt、ppsx、ppsm、key、png、jpg、jpeg、gif、bmp、tiff、webp、heif、heic、jp2、eps、icns、im、pcx、ppm、xbm、xmind 示例值：pdf |
| IsPublic | 否 | Boolean | IsPublic用于上传文件或图片时选择场景，当上传对话端图片时IsPublic为true，上传文件（包括文档库文件/图片等和对话端文件）时IsPublic为false 示例值：false |
| TypeKey | 否 | String | 存储类型: offline:离线文件，realtime:实时文件；为空默认为offline 示例值：offline |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Credentials | Credentials | 密钥信息 |
| ExpiredTime | Integer | 失效时间 示例值：1717063483 |
| StartTime | Integer | 开始时间 示例值：1717062883 |
| Bucket | String | 对象存储桶 示例值：qidian-qbot-test-1251316161 |
| Region | String | 对象存储可用区 示例值：ap-guangzhou |
| FilePath | String | 文件存储目录 示例值：/corp/137/doc/ |
| Type | String | 存储类型 示例值：cos |
| CorpUin | String | 企业主账号 示例值：0 |
| ImagePath | String | 图片存储目录 示例值：/corp/17685678771866/image/ |
| UploadPath | String | 上传存储路径，到具体文件 示例值：/corp/1768567877186617344/1768574873671565312/doc/XIEVIQBxpnltliscsSAu-1796171935184060416.pdf |
| UploadUrl | String | 文件上传地址，使用put请求上传文件到该地址 示例值：https://lke-realtime-1251316161.cos.ap-guangzhou.myqcloud.com/%2Fcorp/xxxxxxxxxx/xxxxxxxxx/doc/xxxxxxxxxxx-2020788481547555584.xlsx?q-sign-algorithm=sha1&q-ak=AKIDqQ2UCeGDtjVkjauVp8NM1czNWPAgwvhF&q-sign-time=1770628493%3B1770630293 |
| FileUrl | String | 文件的预签名地址，支持下载 示例值：https://lke-realtime-1251316161.cos.ap-guangzhou.myqcloud.com/%2Fcorp/xxxxxxxxxx/xxxxxxxxx/doc/xxxxxxxxxxx-2020788481547555584.xlsx?q-sign-algorithm=sha1&q-ak=AKIDqQ2UCeGDtjVkjauVp8NM1czNWPAgwvhF&q-sign-time=1770628493%3B1770630293 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取对象存储上传密钥
输入示例
POST / HTTP/1.1
Host: lke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeStorageCredential
<公共请求参数>
{
"BotBizId": "1727231073371148288"
}输出示例
{
"Response": {
"Bucket": "qidian-qbot-test-1251316161",
"CorpUin": "0",
"Credentials": {
"TmpSecretId": "***************************************************",
"TmpSecretKey": "***************************************************",
"Token": "***************************************************"
},
"ExpiredTime": 1701429243,
"FilePath": "/corp/137/doc/",
"Region": "ap-guangzhou",
"RequestId": "87d578f9-6de5-4515-906e-d28e56d33fe0",
"StartTime": 1701425643,
"Type": "cos"
}
}示例2 获取文档上传密钥
离线文档
输入示例
POST / HTTP/1.1
Host: lke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeStorageCredential
<公共请求参数>
{
"BotBizId": "1779863007508561920",
"FileType": "md",
"TypeKey": "offline"
}输出示例
{
"Response": {
"Bucket": "qidian-qbot-test-1251316161",
"CorpUin": "0",
"Credentials": {
"TmpSecretId": "*****************************************",
"TmpSecretKey": "***************************************",
"Token": "*******************************************************"
},
"ExpiredTime": 1717063483,
"FilePath": "",
"ImagePath": "",
"Region": "ap-guangzhou",
"RequestId": "11b8fa96-4700-4f11-8eb0-421de37ed48d",
"StartTime": 1717062883,
"Type": "cos",
"UploadPath": "/corp/1737374499879124992/1779863007508561920/doc/QUiGRdWFAFBkDKjhuxbd-1796118032488595456.md"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
