获取出证报告任务执行结果
1. 接口描述
接口请求域名： ess.tencentcloudapi.com 。
获取出证报告任务执行结果，返回报告 URL。
注意：
- 使用此功能`需搭配出证套餐` ，使用前请联系对接的客户经理沟通。
- 需调用创建并返回出证报告接口提交申请出证报告任务获取报告编号后调用当前接口获取报告链接。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeFlowEvidenceReport。 |
| Version | 是 | String | 公共参数，本接口取值：2020-11-11。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| Operator | 是 | UserInfo | 执行本接口操作的员工信息。 注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。 |
| ReportId | 是 | String | 签署报告编号, 由提交申请出证报告任务产生 |
| Agent | 否 | Agent | 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。 |
| ReportType | 否 | Integer | 指定申请的报告类型，可选类型如下：
示例值：0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ReportUrl | String | 出证报告PDF的下载 URL，有效期为5分钟，超过有效期后将无法再下载。注意：此字段可能返回 null，表示取不到有效值。 示例值：https://file.ess.tencent.cn/file/yDwhIU*****kvSEnAV3Qyl2B/0/1.PDF?hkey=4a8ca49a66dc0b7651**5601d0e6b8aa9a86054c25 |
| Status | String | 出证任务执行的状态, 状态含义如下：
示例值：EvidenceStatusExecuting |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询签署报告
查询签署报告，返回报告 URL
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeFlowEvidenceReport
<公共请求参数>
{
"ReportId": "yDR0PUUhw8ahh****KyK18G1h3FK5ccC",
"Operator": {
"UserId": "de71c67592974c****20572d44ec0b6d"
}
}
输出示例
{
"Response": {
"ReportUrl": "https://file.ess.tencent.cn/file/yDwhIU*****kvSEnAV3Qyl2B/0/1.PDF?hkey=58cce665fd939d77e5895e16e05e893c***ccff7e5f2c81027b190f9ef3bf4e7cb06f02a5b6fea82b7b211d1f85204b11bd66fb28ab960b2b966215ec624b11c422291f68554b8e0f",
"RequestId": "s16679771xxxx693616",
"Status": "EvidenceStatusSuccess"
}
}
示例2 查询公证处核验报告
查询公证处核验报告，报告生成成功后，获取文件下载链接
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeFlowEvidenceReport
<公共请求参数>
{
"ReportId": "yDR0PUUhw8ahh****KyK18G1h3FK5ccC",
"ReportType": 1,
"Operator": {
"UserId": "de71c67592974c****20572d44ec0b6d"
}
}
输出示例
{
"Response": {
"ReportUrl": "https://file.ess.tencent.cn/file/yDwhIU*****kvSEnAV3Qyl2B/0/1.PDF?hkey=58cce665fd939d77e5895e16e05e893c***ccff7e5f2c81027b190f9ef3bf4e7cb06f02a5b6fea82b7b211d1f85204b11bd66fb28ab960b2b966215ec624b11c422291f68554b8e0f",
"RequestId": "s16679771xxxx693616",
"Status": "EvidenceStatusSuccess"
}
}
示例3 查询正在处理中的签署报告
查询正在处理中的签署报告，正在处理中
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeFlowEvidenceReport
<公共请求参数>
{
"ReportId": "yDR0PUUhw8ahh****KyK18G1h3FK5ccC",
"ReportType": 0,
"Operator": {
"UserId": "de71c67592974c****20572d44ec0b6d"
}
}
输出示例
{
"Response": {
"ReportUrl": "",
"RequestId": "3129718393196",
"Status": "EvidenceStatusExecuting"
}
}
5. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError.System | 系统错误，请稍后重试。 |
| InvalidParameter.DataNotFound | 数据不存在。 |
| InvalidParameter.ParamError | 参数错误。 |
| InvalidParameterValue.Mask | 需要屏蔽的告警。 |
| MissingParameter.FlowId | 缺少签署流程id，请检查修改后重试。 |
| OperationDenied.FlowStatusForbid | 签署流程状态不正确，请检查后重试。 |
| OperationDenied.NotBelongSuperAdminOrLegalPerson | 不属于企业超管或者法人。 |
| OperationDenied.WhiteListForbid | 未开通功能白名单，请联系客服处理。 |
| ResourceNotFound.Flow | 签署流程未找到，请检查参数。 |
| ResourceNotFound.FlowApprover | 签署流程的签署人不存在，请检查后重试。 |
| ResourceNotFound.Url | Url不存在。 |
| UnauthorizedOperation.NoPermissionFeature | 请升级到对应版本后即可使用该接口。 |