根据溯源ID查溯源信息

最近更新时间:2024-10-30 17:44:16

我的收藏

1. 接口描述

接口请求域名: trp.tencentcloudapi.com 。

查询溯源ID查溯源信息,通常溯源信息跟生产批次绑定,即一个批次的所有溯源信息都是一样的

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTraceDataById。
Version String 公共参数,本接口取值:2021-05-15。
Region String 公共参数,本接口不需要传递此参数。
Id String 溯源ID
示例值:ccc
CorpId Integer 企业ID
示例值:1000

3. 输出参数

参数名称 类型 描述
TraceData TraceData
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询溯源信息

输入示例

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

{
    "Id": "xfetmgoiky2nms6nk8"
}

输出示例

{
    "Response": {
        "TraceData": {
            "TraceId": "1mO3n3W0LDhAaADGwHjj3",
            "TraceItems": [
                {
                    "Key": "name",
                    "Name": "名称",
                    "Value": "xltest",
                    "Type": "text",
                    "ReadOnly": true,
                    "Hidden": false,
                    "Values": [],
                    "Ext": "",
                    "Attrs": [],
                    "List": []
                },
                {
                    "Key": "avatar",
                    "Name": "主图",
                    "Value": "",
                    "Type": "image",
                    "ReadOnly": false,
                    "Hidden": false,
                    "Values": [
                        "https://webcdn.m.qq.com/anxin/public/4054d20b71d30db847492eecc8057e90.jpg"
                    ],
                    "Ext": "",
                    "Attrs": [],
                    "List": []
                },
                {
                    "Key": "message",
                    "Name": "提示文本",
                    "Value": "商品信息溯源详情",
                    "Type": "text",
                    "ReadOnly": false,
                    "Hidden": false,
                    "Values": [],
                    "Ext": "",
                    "Attrs": [],
                    "List": []
                },
                {
                    "Key": "desc",
                    "Name": "卡片描述",
                    "Value": "二维码已完成扫码,请查看信息",
                    "Type": "text",
                    "ReadOnly": false,
                    "Hidden": false,
                    "Values": [],
                    "Ext": "",
                    "Attrs": [],
                    "List": []
                }
            ],
            "PhaseName": "设计阶段",
            "PhaseData": {
                "AppId": "",
                "AppName": "",
                "AppPath": "",
                "HeadEnabled": false,
                "HeadTitle": "",
                "Key": ""
            },
            "Status": 1,
            "Rank": 1,
            "Type": 1,
            "Code": "https://anxin.qq.com/q99j9ovp5c6sok7l5g",
            "Phase": 2,
            "TraceTime": "2024-10-30T07:16:21.265Z",
            "CreateTime": "2024-10-30T07:16:21.265Z",
            "ChainStatus": 1,
            "ChainTime": "2024-10-30T07:16:21.265Z",
            "ChainData": {
                "BlockTime": "2024-03-27T03:33:21.000Z",
                "BlockHash": "129fd196158b497b88bcb02ac7b34f3729c806e925074b448bad35f3da960072",
                "BlockHeight": "684"
            },
            "CorpId": 10000
        },
        "RequestId": "eaa3ccac-d2f5-4df0-a8b3-7b51324e9283"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation 操作失败。
InvalidParameter 参数错误。