查询转换任务状态

1. 接口描述

接口请求域名： ess.tencentcloudapi.com 。

通过发起转换任务接口（CreateConvertTaskApi）返回的任务Id查询转换任务状态，通过本接口确认转换任务是否完成。
大文件转换所需的时间可能会比较长。

默认接口请求频率限制：300次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：GetTaskResultApi。
Version	是	String	公共参数，本接口取值：2020-11-11。
Region	否	String	公共参数，本接口不需要传递此参数。
TaskId	是	String	任务Id，通过CreateConvertTaskApi得到
Operator	否	UserInfo	操作人信息,UserId必填

3. 输出参数

参数名称	类型	描述
TaskId	String	任务Id
TaskStatus	Integer	任务状态，需要关注的状态 0 :NeedTranform - 任务已提交 4 :Processing - 文档转换中 8 :TaskEnd - 任务处理完成 -2 :DownloadFailed - 下载失败 -6 :ProcessFailed - 转换失败 -13:ProcessTimeout - 转换文件超时
TaskMessage	String	状态描述，需要关注的状态 NeedTranform - 任务已提交 Processing - 文档转换中 TaskEnd - 任务处理完成 DownloadFailed - 下载失败 ProcessFailed - 转换失败 ProcessTimeout - 转换文件超时
ResourceId	String	资源Id，也是FileId，用于文件发起使用
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 test示例

通过转换任务Id查询任务状态

输入示例

POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetTaskResultApi
<公共请求参数>

{
    "Operator": {
        "UserId": "yDxoQUUgydjfn4yaUuO4zjEyd1h2hnnR"
    },
    "TaskId": "20220726183047992850"
}

输出示例

{
    "Response": {
        "RequestId": "2255xxxxx76-6192fc301053",
        "ResourceId": "yDRtsUxxxxxjEyx4jZM3A7",
        "TaskId": "2022072xxxx992850",
        "TaskMessage": "任务处理完成",
        "TaskStatus": 8
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InternalError.System	系统错误，请稍后重试。
InvalidParameter.ParamError	参数错误。
InvalidParameter.ResourceType	不合法的资源类型，请联系客服了解，并在修改后重试。
MissingParameter.ResourceName	缺少资源名称，请检查修改后重试。
OperationDenied.Forbid	禁止此项操作。
UnauthorizedOperation.NoPermissionFeature	请升级到对应版本后即可使用该接口。

1. 接口描述​

2. 输入参数​

3. 输出参数​

4. 示例​

示例1 test示例​

输入示例​

输出示例​

5. 开发者资源​

腾讯云 API 平台​

API Inspector​

SDK​

命令行工具​

6. 错误码​