跳到主要内容

查询合同归档任务状态

1. 接口描述​

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

查询归档任务的执行结果， 用于获取合同归档任务的当前处理状态及执行结果。

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

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

2. 输入参数​

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

参数名称必选类型描述
Action是String公共参数，本接口取值：DescribeArchiveFlowTask。
Version是String公共参数，本接口取值：2020-11-11。
Region否String公共参数，此参数为可选参数。
Operator是UserInfo

执行本接口操作的员工信息。注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。

TaskId是String

任务id，创建归档任务时返回


示例值：yD3h6UUck*bBSBfp

3. 输出参数​

参数名称类型描述
StatusInteger

任务状态

枚举值：

  • 0： 待处理
  • 1： 处理中
  • 2： 任务完成
  • 3： 任务完成(存在失败)

示例值：2
ArchiveFlowResultsArray of ArchiveFlowResult

每条合同的处理结果，与创建任务的archive_flows列表顺序一致

RequestIdString唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例​

示例1 根据任务id查询归档任务状态​

输入示例​

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

{
    "Operator": {
        "UserId": "yDtT9UUck*****************NQ0bO6"
    },
    "TaskId": "yD3h6UUck*****************bBSBfp"
}

输出示例​

{
    "Response": {
        "ArchiveFlowResults": [
            {
                "ArchiveFlowStatus": 0,
                "BusinessId": "测试1-business_id",
                "ErrorMessage": "",
                "FlowId": "yD3h6UUckp***************2sDw4ME",
                "ResourceIdList": [
                    "yD3hnUUck*****************OnrcHE"
                ]
            }
        ],
        "Status": 2,
        "RequestId": "45ba5969-15db-407b-8eb7-454884394151"
    }
}

5. 错误码​

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

错误码描述
InternalError.Db数据库异常。
InternalError.Serialize序列化错误。
InvalidParameter参数错误。
MissingParameter缺少参数错误。
ResourceNotFound资源不存在。
更多开发者交流反馈