1. 接口描述
接口请求域名: btoe.tencentcloudapi.com 。
用户通过存证编码向BTOE获取存证文件的下载URL。
-注:Hash类存证、业务数据明文存证不产生存证文件。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:GetDepositFile。 |
Version | 是 | String | 公共参数,本接口取值:2021-05-14。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
EvidenceId | 是 | String | 存证编码 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
EvidenceId | String | 存证编号 |
EvidenceFile | String | 存证文件临时链接 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 存证文件查询
用户通过存证编码向BTOE获取存证文件的下载URL。
输入示例
POST / HTTP/1.1
Host: btoe.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetDepositFile
<公共请求参数>
{
"EvidenceId": "存证编码"
}
输出示例
{
"Response": {
"RequestId": "testtest33111113333111",
"EvidenceId": "testt222e32278733387121ststtest",
"EvidenceFile": "http://xxxx.cos.xxxx.myqcloud.com/btoe%2620210326%26testt222e32278733387121ststtest.png?sign=q-sign-algorithm%3Dsha1%26q-ak%3Dsdfgsdfgsdvsevrsdfgsdfg%26q-sign-time%3D1617003400%3B1617007000%26q-key-time%3D1617003400%3B1617007000%26q-header-list%3Dhost%26q-url-param-list%3D%26q-signature%3D2c2c544622742db817848beff9580c51804ec7f0"
}
}
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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
FailedOperation.ArrearsError | 帐号已欠费。 |
FailedOperation.CountLimitError | 今日次数达到限制。 |
FailedOperation.DataInfoTooLong | 数据明文内容过长。 |
FailedOperation.DownLoadError | 文件下载失败。 |
FailedOperation.HashNoMatch | 哈希不匹配。 |
FailedOperation.OnChainFailure | 上链失败。 |
FailedOperation.QueryNoRecord | 查询无记录。 |
FailedOperation.SensitiveData | 敏感数据。 |
FailedOperation.UnKnowError | 未知错误。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.AccountInfoInvalid | 用户数据无效。 |
InvalidParameter.InvalidFileSuffix | 文件后缀不正确。 |
InvalidParameter.InvalidParameterValue | 参数值错误。 |
InvalidParameterValue | 参数取值错误。 |
LimitExceeded.TooLargeFileError | 文件内容太大。 |
ResourceInsufficient.LowBalance | 余额不足。 |
ResourceUnavailable.ResourceNotOpened | 资源未完成开通。 |