互动白板查询白板日志-其他接口-API 中心-腾讯云

1. 接口描述

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

查询客户端白板日志

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeBoardSDKLog。
Version	是	String	公共参数，本接口取值：2019-09-19。
Region	是	String	公共参数，详见产品支持的地域列表。
SdkAppId	是	Integer	白板应用的SdkAppId 示例值：1400000001
RoomId	是	String	需要查询日志的白板房间号示例值：10000
UserId	是	String	需要查询日志的用户ID 示例值：tic_web
TimeRange.N	是	Array of Integer	查询时间段，Unix时间戳，单位毫秒，第一个值为开始时间戳，第二个值为结束时间示例值：[1614519034000,1614691834999]
AggregationInterval	是	String	聚合日志条数查询的桶的时间范围，如5m, 1h, 4h等示例值：5m
Query	否	String	额外的查询条件示例值：action: addData
Ascending	否	Boolean	是否按时间升序排列示例值：false
Context	否	String	用于递归拉取的上下文Key，在上一次请求中返回示例值：空

3. 输出参数

参数名称	类型	描述
Total	Integer	总共能查到日志条数示例值：65
Sources	Array of String	日志详细内容示例值：[]
Buckets	Array of String	按时间段聚合后每个时间段的日志条数示例值：[]
Context	String	用于递归拉取的上下文Key，下一次请求的时候带上示例值：空
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询白板日志

输入示例

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

{
    "SdkAppId": 1400000001,
    "RoomId": "73394291",
    "UserId": "tic_web",
    "TimeRange": [
        1614519034000,
        1614691834999
    ],
    "Context": "",
    "AggregationInterval": "1h",
    "Query": "",
    "Ascending": true
}

输出示例

{
    "Response": {
        "RequestId": "52214ab1-eeaa-4c9a-aa8f-6c501f7cae18",
        "Total": 65,
        "Context": "",
        "Sources": [],
        "Buckets": []
    }
}

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	操作失败。
UnauthorizedOperation	未授权操作。
UnauthorizedOperation.SdkAppId	SdkAppId不存在或者SdkAppId与当前腾讯云账号不对应。

查询白板日志

本页目录：