创建文件转换任务
1. 接口描述
接口请求域名: ess.tencentcloudapi.com 。
上传了word、excel文件后,通过该接口发起文件转换任务,将word、excel文件转换为pdf文件。
默认接口请求频率限制:300次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateConvertTaskApi。 |
Version | 是 | String | 公共参数,本接口取值:2020-11-11。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
ResourceType | 是 | String | 资源类型 取值范围doc,docx,html,xls,xlsx之一 |
ResourceName | 是 | String | 资源名称,长度限制为256字符 |
ResourceId | 是 | String | 资源Id,通过UploadFiles获取 |
Operator | 否 | UserInfo | 调用方用户信息,userId 必填 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TaskId | String | 转换任务Id |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 调用示例
适用场景:通过word文件资源id进行文件转换
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateConvertTaskApi
<公共请求参数>
{
"ResourceType": "doc",
"ResourceId": "y***********************************l",
"Operator": {
"UserId": "y***********************************p"
},
"ResourceName": "hello.docx"
}
输出示例
{
"Response": {
"RequestId": "b2eae8xxxx61cfaf19a21",
"TaskId": "202xxxx3011294"
}
}
示例2 test示例
适用场景:通过word文件资源id进行文件转换
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateConvertTaskApi
<公共请求参数>
{
"ResourceType": "doc",
"ResourceName": "hello.docx",
"Operator": {
"UserId": "y***********************************R"
},
"ResourceId": "y***********************************l"
}
输出示例
{
"Response": {
"RequestId": "fbf25f31-xxxxxfed19e9849",
"TaskId": "20220xxxx549202141"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError.DependsApi | 依赖的第三方API返回错误。 |
InvalidParameter.InvalidId | id类型参数不合法,请检查后重试。 |
InvalidParameter.ParamError | 参数错误。 |
InvalidParameter.ResourceType | 不合法的资源类型,请联系客服了解,并在修改后重试。 |
MissingParameter.ResourceName | 缺少资源名称,请检查修改后重试。 |
OperationDenied.Forbid | 禁止此项操作。 |
OperationDenied.NoIdentityVerify | 未通过个人实名认证。 |
UnauthorizedOperation.NoPermissionFeature | 请升级到对应版本后即可使用该接口。 |