有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

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

修改溯源信息

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyTraceData。
Version String 公共参数,本接口取值:2021-05-15。
Region String 公共参数,本接口不需要传递此参数。
TraceId String 溯源ID
示例值:VyKxxkmi_myRD6ulG6HFo
BatchId String 批次ID
示例值:ccc
TaskId String 生产溯源任务ID
示例值:1
TraceItems.N Array of TraceItem 溯源信息
PhaseName String 溯源阶段名称
示例值:名称
PhaseData PhaseData 环节数据
Status Integer 溯源状态 0: 无效, 1: 有效
示例值:1
Rank Integer 排序
示例值:1
Type Integer [无效] 类型
示例值:1
Code String [无效] 溯源码
示例值:xfetmgoiky2nms6nk8
Phase Integer [无效] 溯源阶段 0:商品 1:通用 2:生产溯源 3:销售溯源
示例值:1
TraceTime String [无效] 溯源时间
示例值:2021-12-03T02:58:48.000Z
CreateTime String [无效] 创建时间
示例值:2021-12-03T02:58:48.000Z
ChainStatus Integer [无效] 上链状态
示例值:1
ChainTime String [无效] 上链时间
示例值:2021-12-03T02:58:48.000Z
ChainData ChainData [无效] 上链数据
CorpId Integer 企业ID
示例值:1000

3. 输出参数

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

4. 示例

示例1 修改溯源信息

修改部分溯源信息

输入示例

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

{
    "TraceId": "abc",
    "BatchId": "abc",
    "TaskId": "abc",
    "TraceItems": [
        {
            "Name": "abc",
            "Value": "abc",
            "Type": "abc",
            "ReadOnly": true,
            "Hidden": true,
            "Values": [
                "abc"
            ],
            "Key": "abc",
            "Ext": "abc",
            "Attrs": {
                "Name": "abc",
                "Value": "abc",
                "Type": "abc",
                "ReadOnly": true,
                "Hidden": true,
                "Values": [
                    "abc"
                ],
                "Key": "abc",
                "Ext": "abc",
                "Attrs": {
                    "Name": "abc",
                    "Value": "abc",
                    "Type": "abc",
                    "ReadOnly": true,
                    "Hidden": true,
                    "Values": [
                        "abc"
                    ],
                    "Key": "abc",
                    "Ext": "abc"
                }
            }
        }
    ],
    "PhaseName": "abc",
    "PhaseData": {
        "HeadEnabled": true,
        "HeadTitle": "abc",
        "Key": "abc",
        "AppId": "abc",
        "AppPath": "abc",
        "AppName": "abc"
    },
    "Status": 1,
    "Rank": 1,
    "Type": 1,
    "Code": "abc",
    "Phase": 1,
    "TraceTime": "abc",
    "CreateTime": "abc",
    "ChainStatus": 1,
    "ChainTime": "abc",
    "ChainData": {
        "BlockHash": "abc",
        "BlockHeight": "abc",
        "BlockTime": "abc"
    },
    "CorpId": 1
}

输出示例

{
    "Response": {
        "TraceId": "abc",
        "RequestId": "abc"
    }
}

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 参数错误。