1. 接口描述
接口请求域名: trp.tencentcloudapi.com 。
支持增量查询扫码日志,通常提供给数据同步使用,调用时需要指定从哪一行开始查询数据
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeRawScanLogs。 |
Version | 是 | String | 公共参数,本接口取值:2021-05-15。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
CorpId | 否 | Integer | 企业ID, 默认为当前企业 如果有渠道权限,可以传 0 会查渠道下所有的企业 示例值:10000 |
PageSize | 否 | Integer | 分页数量,默认为 20,最大为 1000 示例值:100 |
PageNumber | 否 | Integer | 当前分页,默认为 1 示例值:1 |
AfterLogId | 否 | Integer | 从哪个日志后查询 即: LogId > $AfterLogId 示例值:0 |
StartTime | 否 | String | 开始时间 >= StartTime 示例值:2021-12-06 00:00:00 |
EndTime | 否 | String | 结束时间 < EndTime 示例值:2021-12-07 00:00:00 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ScanLogs | Array of RawScanLog | 原始扫码日志 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 从某个日志开始查询新增的扫码日志
在同步日志的场景,通常只需要定时同步新增的日志,指定上一次请求时最后一行ID即可(初次请求时可以传 0)
例如:AfterLogId = 100, 表示查 LogId > 100 的日志,在返回空数组时表示没有新的日志了
输入示例
POST / HTTP/1.1
Host: trp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRawScanLogs
<公共请求参数>
{
"PageSize": 100,
"PageNumber": 1,
"AfterLogId": 100
}
输出示例
{
"Response": {
"ScanLogs": [
{
"LogId": 101,
"Openid": "g3ST2ZYcreGP9jpqgKHOjuB1e0GrlI0t",
"CreateTime": "2024-10-30T07:16:21.265Z",
"Code": "https://anxin.qq.com/q99j9ovp5c6sok7l5g",
"CorpId": 10000,
"MerchantId": "pn30msjjxwga",
"ProductId": "97zu51y30awe",
"BatchId": "20241022112952826",
"Province": "广东省",
"City": "深圳市",
"District": "福田区"
}
],
"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。
- 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 | 参数错误。 |