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

1. 接口描述

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

结构化复核差异查询接口,对比结构化复核前后数据差异,返回差异的部分。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeStructureDifference。
Version String 公共参数,本接口取值:2021-04-08。
Region String 公共参数,本接口不需要传递此参数。
MainTaskId String 主任务号
示例值:fybnnac89vk
SubTaskId String 子任务号
示例值:fybnnac89vl

3. 输出参数

参数名称 类型 描述
MainTaskId String 主任务号
示例值:fybnnac89vk
Status Integer 结果状态:
0:返回成功
1:结果未生成
2:结果生成失败
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Results Array of PerStructDifference 差异的结果数组
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 结构化对比查询接口示例

输入示例

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

{
    "MainTaskId": "fybnnac89vk",
    "SubTaskId": ""
}

输出示例

{
    "Response": {
        "MainTaskId": "fybnnac89vk",
        "Status": 0,
        "Results": [
            {
                "SubTaskId": "Snz0ypwht1xd",
                "TaskType": "BUltrasoundReport",
                "ModifyItems": [
                    {
                        "Path": "detailInfo/desc/organs/imageFeature/src",
                        "Machine": "回声",
                        "Manual": "回声均匀"
                    }
                ],
                "NewItems": [
                    {
                        "Path": "detailInfo/summary/syms/attrs/性质",
                        "Value": "{\"__key\":\"f8ycfblrrh8\",\"desc\":\"性质\",\"indexChar\":-1,\"indexRow\":-1,\"positive\":\"\",\"src\":\"\",\"type\":\"\",\"value\":\"测试888888\"}"
                    }
                ],
                "RemoveItems": [
                    {
                        "Path": "detailInfo/desc/organs/sizes",
                        "Value": "[{\"__key\":\"nz0yrpr2ux4\",\"desc\":\"\",\"indexChar\":130,\"indexRow\":0,\"numbers\":[29],\"src\":\"厚2.9CM\",\"type\":\"厚\",\"unit\":\"MM\",\"value\":\"厚2.9CM\"}]"
                    }
                ]
            }
        ],
        "RequestId": "6e2f2787-1851-4bf1-8477-08c93b6ee652"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。