1. 接口描述
接口请求域名： trp.tencentcloudapi.com 。
查询溯源信息，通常溯源信息跟生产批次绑定，即一个批次的所有溯源信息都是一样的
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeTraceDataList。 |
| Version | 是 | String | 公共参数，本接口取值：2021-05-15。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| CorpId | 否 | Integer | 企业ID 示例值：1000 |
| BatchId | 否 | String | 批次ID 示例值：ccc |
| TaskId | 否 | String | 任务ID 用于外部溯源 示例值：1 |
| PageNumber | 否 | Integer | 页数 示例值：1 |
| Code | 否 | String | 二维码 示例值：xfetmgoiky2nms6nk8 |
| Phase | 否 | Integer | 溯源阶段 0:商品 1:通用 2:内部溯源 3:外部溯源 示例值：0 |
| PageSize | 否 | Integer | 数量 示例值：10 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 数量 示例值：10 |
| TraceDataList | Array of TraceData | 无 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询溯源信息
输入示例
POST / HTTP/1.1
Host: trp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTraceDataList
<公共请求参数>
{
"BatchId": "xfetmgoiky2nms6nk8",
"Code": "",
"PageSize": 10,
"PageNumber": 1
}输出示例
{
"Response": {
"TotalCount": 1,
"TraceDataList": [
{
"Type": 1,
"ChainStatus": 1,
"Code": "xx",
"CorpId": 1,
"TraceItems": [
{
"Name": "xx",
"ReadOnly": true,
"Value": "xx",
"Ext": "xx",
"Values": [
"xx"
],
"Hidden": true,
"Type": "xx"
}
],
"Rank": 1,
"TraceId": "xx",
"PhaseName": "xx",
"TraceTime": "xx",
"Phase": 1,
"ChainData": {
"BlockHeight": 1,
"BlockHash": "xx"
},
"ChainTime": "xx",
"CreateTime": "xx"
}
],
"RequestId": "xx"
}
}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 | 操作失败。 |
| InvalidParameter | 参数错误。 |