腾讯安心平台查询二维码列表-API 文档-文档中心-腾讯云

1. 接口描述

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

查询二维码列表

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeTraceCodes。
Version	是	String	公共参数，本接口取值：2021-05-15。
Region	否	String	公共参数，本接口不需要传递此参数。
Keyword	否	String	搜索关键字码标识，或者批次ID 示例值：code
PageNumber	否	Integer	条数示例值：1
PageSize	否	Integer	页码示例值：1
BatchId	否	String	批次ID，弃用示例值：abc
CorpId	否	Integer	企业ID 示例值：10000

3. 输出参数

参数名称	类型	描述
TraceCodes	Array of TraceCode	标识列表注意：此字段可能返回 null，表示取不到有效值。
TotalCount	Integer	条数注意：此字段可能返回 null，表示取不到有效值。示例值：1
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询标识列表

输入示例

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

{
    "Keyword": "xfetmgoiky2nms6nk8",
    "PageSize": 10,
    "PageNumber": 1
}

输出示例

{
    "Response": {
        "TraceCodes": [
            {
                "Code": "abc",
                "CorpId": 1,
                "PackId": "abc",
                "BatchId": "abc",
                "MerchantId": "abc",
                "ProductId": "abc",
                "Status": 1,
                "CreateTime": "abc",
                "UpdateTime": "abc",
                "MerchantName": "abc",
                "ProductName": "abc",
                "AgentId": 1,
                "Level": 1,
                "PackSpec": [
                    {
                        "Level": 1,
                        "Rate": 1,
                        "Amount": 1,
                        "CustomId": "abc",
                        "CodeParts": [
                            {
                                "Name": "abc",
                                "Type": "abc",
                                "Value": "abc",
                                "Length": 1,
                                "Ext": "abc"
                            }
                        ],
                        "Unit": "abc",
                        "SceneCode": 0
                    }
                ]
            }
        ],
        "TotalCount": 1,
        "RequestId": "abc"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

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