文件上传
1. 接口描述
接口请求域名: file.ess.tencent.cn 。
此接口(UploadFiles)用于文件上传。 其中上传的文件,图片类型(png/jpg/jpeg)大小限制为5M,其他大小限制为60M。 调用时需要设置Domain, 正式环境为 file.ess.tencent.cn。 代码示例: HttpProfile httpProfile = new HttpProfile(); httpProfile.setEndpoint("file.test.ess.tencent.cn");
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:UploadFiles。 |
Version | 是 | String | 公共参数,本接口取值:2021-05-26。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
Agent | 是 | Agent | 应用相关信息,若是第三方应用集成调用 appid 和proxyappid 必填 |
BusinessType | 是 | String | 文件对应业务类型 1. TEMPLATE - 模板; 文件类型:.pdf/.doc/.docx/.html 2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型:.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html |
FileInfos.N | 否 | Array of UploadFile | 上传文件内容数组,最多支持20个文件 |
Operator | 否 | UserInfo | 操作者的信息 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
FileIds | Array of String | 文件id数组,有效期一个小时;有效期内此文件id可以反复使用 |
TotalCount | Integer | 上传成功文件数量 |
FileUrls | Array of String | 文件Url |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 多文件上传接口
多文件上传
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UploadFiles
<公共请求参数>
{
"Agent": {
"ProxyAppId": "abc",
"ProxyOperator": {
"OpenId": "abc"
},
"AppId": "abc"
},
"BusinessType": "TEMPLATE",
"FileInfos": [
{
"FileBody": "iVBORw0KGgoAAAANSUhxxxxAElEQVR4Xu3dbah1W5eQ7HmoAAAAASUVORK5CYII=",
"FileName": "a.pdf"
}
]
}
输出示例
{
"Response": {
"FileIds": [
"d54e****************A2b7562"
],
"FileUrls": [
"https://a.b.com/d5****************2b7562"
],
"TotalCount": 1,
"RequestId": "4fecd****************bdbb7e5"
}
}
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
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
- Tencent Cloud SDK 3.0 for Ruby
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
FailedOperation | 操作失败。 |
InternalError.Serialize | 序列化错误。 |
InvalidParameter | 参数错误。 |
OperationDenied | 操作被拒绝。 |
ResourceNotFound | 资源不存在。 |
UnauthorizedOperation.NoPermissionFeature | 请升级到对应版本后即可使用该接口。 |