云开发 CloudBase 搜索CLS日志-API 文档-文档中心-腾讯云

1. 接口描述

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

搜索CLS日志，TCB角色密钥访问

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：SearchClsLog。
Version	是	String	公共参数，本接口取值：2018-06-08。
Region	否	String	公共参数，本接口不需要传递此参数。
EnvId	是	String	环境唯一ID 示例值：env-aabbccdd
StartTime	是	String	查询起始时间条件示例值：2023-01-01 00:00:00
EndTime	是	String	查询结束时间条件示例值：2023-01-01 01:00:00
QueryString	是	String	查询语句，详情参考 https://cloud.tencent.com/document/product/614/47044 示例值：fun
Limit	是	Integer	单次要返回的日志条数，单次返回的最大条数为100 示例值：10
Context	否	String	加载更多使用，透传上次返回的 context 值，获取后续的日志内容，通过游标最多可获取10000条，请尽可能缩小时间范围示例值：abc
Sort	否	String	按时间排序 asc（升序）或者 desc（降序），默认为 desc 示例值：asc
UseLucene	否	Boolean	是否使用Lucene语法，默认为false 示例值：false

3. 输出参数

参数名称	类型	描述
LogResults	LogResObject	日志内容结果
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 搜索CLS日志

搜索CLS日志

输入示例

https://tcb.tencentcloudapi.com/?Action=SearchClsLog
&EnvId=test-12323
&StartTime=abc
&EndTime=def
&Limit=10
&QueryString=x
&Sort=desc
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "3e22b381-93a3-44c4-85b7-456679a7b8cd",
        "LogResults": {
            "Context": "",
            "ListOver": true,
            "Results": []
        }
    }
}

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签名/鉴权错误。
AuthFailure.UnauthorizedOperation	您没有查看该资源的权限。
InternalError	内部错误。
InvalidParameter	参数错误。