查询转换任务状态
1. 接口描述
接口请求域名: ess.tencentcloudapi.com 。
此接口(GetTaskResultApi)用来查询转换任务的状态。如需发起转换任务,请使用创建文件转换任务接口进行资源文件的转换操作
前提条件:已调用 创建文件转换任务接口进行文件转换,并得到了返回的转换任务Id。
适用场景:已创建一个文件转换任务,想查询该文件转换任务的状态,或获取转换后的文件资源Id。
注:
大文件转换所需的时间可能会比较长
本接口返回的文件资源ID就是PDF资源ID,可以直接用于【用PDF文件创建签署流程】接口发起合同。
默认接口请求频率限制:300次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:GetTaskResultApi。 |
Version | 是 | String | 公共参数,本接口取值:2020-11-11。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
TaskId | 是 | String | 转换任务Id,通过接口创建文件转换任务接口或创建多文件转换任务接口 得到的转换任务id |
Operator | 否 | UserInfo | 执行本接口操作的员工信息。 注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。 |
Agent | 否 | Agent | 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TaskId | String | 任务Id |
TaskStatus | Integer | 任务状态,需要关注的状态
|
TaskMessage | String | 状态描述,需要关注的状态
|
ResourceId | String | 资源Id(即FileId),用于用PDF文件创建签署流程 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 通过转换任务Id查询任务状态
通过转换任务Id查询任务状态
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetTaskResultApi
<公共请求参数>
{
"Operator": {
"UserId": "yDxoQxxxxxxxxxxxxxxxxxx1h2hnnR"
},
"TaskId": "2022xxxxxxxxxx992850"
}
输出示例
{
"Response": {
"RequestId": "2255xxxxx76-6192fc301053",
"ResourceId": "yDRtsUxxxxxjEyx4jZM3A7",
"TaskId": "2022072xxxx992850",
"TaskMessage": "任务处理完成",
"TaskStatus": 8
}
}
5. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError.System | 系统错误,请稍后重试。 |
InvalidParameter.ParamError | 参数错误。 |
InvalidParameter.ResourceType | 不合法的资源类型,请联系客服了解,并在修改后重试。 |
MissingParameter.ResourceName | 缺少资源名称,请检查修改后重试。 |
OperationDenied.Forbid | 禁止此项操作。 |
UnauthorizedOperation.NoPermissionFeature | 请升级到对应版本后即可使用该接口。 |