创建并返回出证报告

1. 接口描述

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

创建出证报告，返回报告 ID。需要配合出证套餐才能调用。出证需要一定时间，建议调用创建出证24小时之后再通过DescribeFlowEvidenceReport进行查询。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateFlowEvidenceReport。
Version	是	String	公共参数，本接口取值：2020-11-11。
Region	否	String	公共参数，本接口不需要传递此参数。
Operator	是	UserInfo	调用方用户信息，userId 必填
FlowId	是	String	签署流程编号

3. 输出参数

参数名称	类型	描述
ReportId	String	出证报告 ID，用于查询出证报告DescribeFlowEvidenceReport接口时用到注意：此字段可能返回 null，表示取不到有效值。
Status	String	执行中：EvidenceStatusExecuting 成功：EvidenceStatusSuccess 失败：EvidenceStatusFailed
ReportUrl	String	废除，字段无效注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建并返回出证报告

获取全部签署完成的合同得出证报告，返回报告 Id

输入示例

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

{
    "FlowId": "yDR0PUUhw8ahh****KyK18G1h3FK5ccC",
    "Operator": {
        "OpenId": "",
        "ClientIp": "113.***.**.65",
        "ProxyIp": "",
        "Channel": "",
        "UserId": "de71c67592974c****20572d44ec0b6d"
    }
}

输出示例

{
    "Response": {
        "ReportUrl": "",
        "ReportId": "yDRspUUgxxxx7PA0xEQpJXh2b",
        "RequestId": "s1667xxx04693616",
        "Status": "EvidenceStatusSuccess"
    }
}

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	参数错误。
InvalidParameterValue.Mask	需要屏蔽的告警。
MissingParameter.FlowId	缺少签署流程id，请检查修改后重试。
OperationDenied.FlowStatusForbid	签署流程状态不正确，请检查后重试。
OperationDenied.NotBelongSuperAdminOrLegalPerson	不属于企业超管或者法人。
OperationDenied.WhiteListForbid	未开通功能白名单，请联系客服处理。
ResourceNotFound.Flow	签署流程未找到，请检查参数。
ResourceNotFound.FlowApprover	签署流程的签署人不存在，请检查后重试。
ResourceNotFound.Url	Url不存在。
UnauthorizedOperation.NoPermissionFeature	请升级到对应版本后即可使用该接口。

1. 接口描述​

2. 输入参数​

3. 输出参数​

4. 示例​

示例1 创建并返回出证报告​

输入示例​

输出示例​

5. 开发者资源​

腾讯云 API 平台​

API Inspector​

SDK​

命令行工具​

6. 错误码​