1. 接口描述
接口请求域名: ess.tencentcloudapi.com 。
本接口(DescribeContractReviewMarkedRiskExportTask)用于查询由 ExportContractReviewMarkedRisk 接口创建的导出任务状态。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeContractReviewMarkedRiskExportTask。 |
| Version | 是 | String | 公共参数,本接口取值:2020-11-11。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| Operator | 是 | UserInfo | 执行本接口操作的员工信息。 注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。 |
| TaskId | 是 | String | 导出任务 ID。 示例值:yD3aDUUk**aun*UusRvfaSfh2BjyG9 |
| Agent | 否 | Agent | 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Url | String | 导出文件 url。 示例值:https://file.test.ess.tencent.cn/bresource/resource/resource/0/0.XLSX?hkey=8c9a560a2e1abd3a860cc8430c67 |
| Status | Integer | 任务状态。未知 = 0; 创建完成 = 1; 队列中 = 2; 执行中 = 3; 执行成功 = 4; 失败 = 5; 终止 = 6; 示例值:4 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询导出任务结果
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeContractReviewMarkedRiskExportTask
<公共请求参数>
{
"Operator": {
"UserId": "yDRt****y***5**7***4zjEBBXVnuTnA"
},
"TaskId": "yD3aDUU*k**au*n*UusRvfaSfh2BjyG9"
}
输出示例
{
"Response": {
"Status": 4,
"Url": "https://file.test.ess.tencent.cn/bresource/resource/resource/0/0.XLSX?hkey=8c9a58b90f96e4cda0a051a032d1924d48235338ad86cd451a3f2c47f220a37b74e2a816764c0a2908cb09e8ee73256dc0886f47afa43e83f58a115d35bcb15dadd2c1b0a30076abc3707ec9e198e37167**2********24ac605678e31e6632adac71d544e61b56905b67189be9a2cedf620e0c70d2dc101e48835ca071ee53e66a9c5d160a2e1abdb3a860cc8430c67",
"RequestId": "b304560f-5a5b-483d-8577-ed202688a8db"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InternalError.DependsApi | 依赖的第三方API返回错误。 |
| InternalError.DependsDb | 数据库执行错误。 |
| InternalError.System | 系统错误,请稍后重试。 |
| InvalidParameter.ParamError | 参数错误。 |
| OperationDenied | 操作被拒绝。 |
| OperationDenied.NoLogin | 用户未登录,请先登录后再操作。 |