文档中心>API 中心

获取文件上传临时密钥

最近更新时间:2024-06-21 01:56:41

我的收藏

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
FileType String 文件类型,正常的文件名类型后缀,例如 xlsx、pdf、 docx、png 等
示例值:pdf
IsPublic Boolean IsPublic为空用于上传文件时选择场景,当上传为图片文件是IsPublic为true,上传文档文件时场景IsPublic为false
示例值:false
TypeKey String 存储类型: offline:离线文件,realtime:实时文件;为空默认为offline
示例值:offline

3. 输出参数

参数名称 类型 描述
Credentials Credentials 密钥信息
ExpiredTime Integer 失效时间
StartTime Integer 开始时间
Bucket String 对象存储桶
Region String 对象存储可用区
FilePath String 文件存储目录
Type String 存储类型
CorpUin String 主号
ImagePath String 图片存储目录
UploadPath String 上传存储路径,到具体文件
示例值:/corp/1768567877186617344/1768574873671565312/doc/XIEVIQBxpnltliscsSAu-1796171935184060416.pdf
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": "AKIDijguNrgnblHncqBKsJBrPV5_J6NCCuklAAvcQlNUiArDzMWbEA97tmXFbydKx839",
            "TmpSecretKey": "tI2ka75Gsqj46xx8/TbqhTa2VmUYm11Gi08EkAbkaVQ=",
            "Token": "FS9JPHeDJWa1fjOrV6X0l1XXfwsGUpIa929d1959a6973c640f2248598cf6b21fHmvd_Zw5Geld2CGSAdgsme916AxqAdp3fKBhlKEnTUaUeoFAEUxtiAdL2pL29U9hM8vuRyoY5BJJoH17ucJv5nAoXfR9kaf41NTw0nSUd1XI55EfTzPWUiqOQF7nAyASFeKZZnHq6Capdos04TqSfEYW9ZaODqh0Htc1MCl0rue9Vh9muCJQuMXaH8fkrtigvZHh2fX5yyX4xXJ0mcST1TDbFwFTz5cbUmKMeiwNE_DYXg9Qhbv1LaF9MMFbqCU7UMfWEngpcncHcUL2hPkMYvlZqKAMHjo_SsgaQB8Pg_9gudKUqEDtJhRUzMkyyYYpcZQggGYyPmtbUcGumdugaKPz1HUXiYQWQ_bBVBrqR3V0QiVKWTg8xtgxepJL8RLizOd8q0Oj_cAM9EncPpvjJanaO9xGu7tEjMtD770sbnr0YI2mu16WNgNkhFUucE1OEzeWibshpbCnzi--VArAFuwV30N9ChTobLPd_0rq3J3ekRRobQEMkLxHxS6vcUjCDnYawaVLe9aXtVMD-hy8pVOAydvoB2hxMpczOtHkeyQsy0F-OqCnSI0bhs17OOZfqhoNQhWWR7LI9cSvlP0N-g6QeGpqkAkATTN27W5iLGJoMne49llTDFsD1emH-KTpIL4KcrkPLH_NWN0C52PZByDmAq0xwGCZ5xNU0X9JzUzaMpjVSOlluJDf4_fSzdY8EmBOQCf0EaegY1vDyP3bXTOf8xkRF56AGkYXjm_xpl7zEgXuoojr5yGyOq7iNG4kTCcnkAasZvcbw1ZY9-b6Ae-VlkRnGA5nEUe-v5nsw1UQZAm_YKRDtReQ5vRefZpso76YohBocqbgF1ZF15W__8xVHhX6E4zVrZ9w7Um74fzCyc3_uZH45ockrLr2AH0qjdHE-T397390OXmsON1frQCr7u5Dvkqd4YCLQnuHsPSzB9YO9bXNwzHZU7cGsGliCSi53m1sV2JDu2h07a-i7JyocbHAp4jNW8vIbGjcnjz7qPkOnthztgmScAK1GkeVpOge542a-UEEVxMj6GNWD2D7BMJaxEWV4IG5QsHL13pt3jmlKbSqeovee8OXyn2v4y50zXxwHZdD6i9bVkb7ig"
        },
        "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": "AKIDlL2FKlsigkCspNQyh2s0-IzKd8cBvmEM-r2e3qOu8ilXs66FFH_-CKmHeAZhFeEV",
            "TmpSecretKey": "Vlr4JmRzKR4Z1PJxzuSsMZ/O2VlxtmvJCEjPV7s5ruY=",
            "Token": "fPEfNWwNoY196OMrLtTdt1zsp8dImhWa14cca3e696eb04ac4dfc6f5f1a3a8b19paI6e-FWHCNPijFmf62yF1pPIhtrLz05W2RsGymutFYnsBGI9RfvYtrKTVScVeX_q-PQ5LXND8L78tPNkb39rakw_58aPIgJfZqpmdqQN-bFeJY0OiOJQgexT2V9doqZvy7LusVERxTQalEsTCnaB9juEBd7h_8O9Jc2GGTAs8hZYRTsqwqxfkrZm4oN5ndH0m53RloH2iSWm1BlplB1VlzbUFLsdxLcklcw8pyD0mzYOtW0HiMLRMVlGlmu0HZpSXtvYWFpLrZ-vRPNfxfuFywpU5ZmqHGubte2b8_3iOFPVPgsnT4zLL8tawSfV2qKLdN_lgAfNzguX6ROC_yP-hP5j7jkkBzWsvIcDzTdJmGvkS2vOgA3-uGkVDJwljsm0oPz1rEfxt-mI05z5YYCT7VVeJ-KVWi8UlH6ww9u1NUa9bKarH1XfDddBnh9Womlxb92uOzfv75q2PqIfvaN9BZWrRmfzooPbdIqE74oFaJw6tyZnMu2zAs0VbYRTN0CdiVB-IggNVaWoQulSFWLL7NRSIGUzjyoUyt_K2XYjV64sYG4Cwpiqe3BteV61p6m_IPEM4hEgb23hhIiytg8JmFWwJZNLJ3Uu6SB8kidb7wjTNGucfFGvDXgzOnqVbcQnTeva0PZ3XkjBNdplYd6RdWl7N54zawxk6R4Ib8pZ1hDuogXTJ5sjwVuQmmMYGUroQY39omyLMGl2zxEXm5uig"
        },
        "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。

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。