1. 接口描述
接口请求域名: csip.tencentcloudapi.com 。
日志分析检索接口v3
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeCLSLogListV3。 |
| Version | 是 | String | 公共参数,本接口取值:2022-11-21。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| From | 是 | Integer | 开始时间 示例值:1776300037000 |
| To | 是 | Integer | 结束时间 示例值:1776310037000 |
| Query | 是 | String | 查询条件 示例值:* |
| SyntaxRule | 是 | Integer | 语法 示例值:1 |
| Topics.N | 否 | Array of LogContextInfo | 主题 |
| MemberId.N | 否 | Array of String | 集团账号的成员id 示例值:["mem-tencent-testa1b2"] |
| Sort | 否 | String | 排序 示例值:desc |
| Limit | 否 | Integer | limit 示例值:10 |
| Offset | 否 | Integer | offset 示例值:0 |
| SamplingRate | 否 | Float | 采样 示例值:1 |
| HighLight | 否 | Boolean | 是否高亮 示例值:false |
| UseNewAnalysis | 否 | Boolean | 是否采用新分析 示例值:false |
| QueryOptimize | 否 | Integer | 查询优化 示例值:1 |
| TopicId | 否 | String | 主题id 示例值:csip-test-logaccess-251308491-tcss-container_assets |
| Context | 否 | String | 上下文信息 示例值:b1b6-a90d595ac704 |
| SubQueryTypes.N | 否 | Array of String | 查询类型 示例值:["cls_event_type:login"] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Context | String | 上下文 示例值:Y29udGV4dC1mMzI5ZTc0Ny05NzM1LTRmNDQtYjk4NS1hMDA2NjcwNDMwYWIxNzc2MzEwNjMyMzU2 |
| ListOver | Boolean | listover 示例值:false |
| Analysis | Boolean | 是否采用分析 示例值:false |
| Results | Array of LogSearchResult | 结果 |
| ColNames | Array of String | 列名 示例值:["cls_event_type"] |
| AnalysisResults | Array of LogItems | 分析结果 |
| AnalysisRecords | Array of String | 分析记录 示例值:["cls_event_type"] |
| Columns | Array of LogColumn | 列名 |
| SamplingRate | Float | 采样 示例值:0 |
| Topics | LogSearchTopics | 主题信息 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 DescribeCLSLogListV3-test1
输入示例
POST / HTTP/1.1
Host: csip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCLSLogListV3
<公共请求参数>
{
"Topics": [
{
"TopicId": "csip-test-logaccess-251308491-tcss-container_assets"
}
],
"From": 1776300037000,
"To": 1776310037000,
"Query": "*",
"SyntaxRule": 1,
"MemberId": [
"mem-tencent-testa1b2"
],
"Sort": "",
"Limit": 10,
"Offset": 0,
"SamplingRate": 1,
"HighLight": false,
"UseNewAnalysis": false,
"QueryOptimize": 1
}
输出示例
{
"Response": {
"Analysis": false,
"AnalysisResults": [],
"ColNames": [],
"Context": "Y29udGV4dC1mMzI5ZTc0Ny05NzM1LTRmNDQtYjk4NS1hMDA2NjcwNDMwYWIxNzc2MzEwNjMyMzU2",
"ListOver": false,
"Results": [
{
"FileName": "",
"HighLights": [],
"HostName": "",
"IndexStatus": "",
"LogJson": "{\"quuid\":\"95a59821-0b97-4114-a8c6-a42f73ff752e\",\"insert_time\":\"1775739716\",\"host_inner_ip\":\"172.18.10.7\",\"table_id\":\"65490569\",\"table_name\":\"asset_host_info\",\"uuid\":\"95a59821-0b97-4114-a8c6-a42f73ff752e\",\"hostname\":\"QTA_VM\",\"update_time\":\"1776310035\",\"event_type\":\"TCSS_ASSET_HOST\",\"appid\":\"251196288\",\"cls_event_type\":\"asset_host_info\",\"event_mod\":\"MOD\",\"event_time\":\"1776310035\",\"status\":\"ONLINE\"}",
"PkgId": "",
"PkgLogId": "",
"RawLog": "",
"Source": "21.215.132.152",
"Time": 1776310036000,
"TopicId": "89cc4300-c3c5-4011-92c4-6214f59a6169",
"TopicName": "csip-test-logaccess-251308491-tcss-container_assets"
}
],
"SamplingRate": 0,
"Topics": {
"Errors": [],
"Infos": [
{
"Context": "Y29udGV4dC1mMzI5ZTc0Ny05NzM1LTRmNDQtYjk4NS1hMDA2NjcwNDMwYWIxNzc2MzEwNjMyMzU2",
"Period": 180,
"TopicId": "csip-test-logaccess-251308491-tcss-container_assets"
}
]
},
"RequestId": "f353404c-3828-442c-9385-5b3373b20c4b"
}
}
示例2 DescribeCLSLogListV3-test2
输入示例
POST / HTTP/1.1
Host: csip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCLSLogListV3
<公共请求参数>
{
"From": 1776300037000,
"To": 1776310037000,
"Query": "*",
"SyntaxRule": 1,
"Topics": [
{
"TopicId": "topic-cls-testq",
"Context": "context-aa"
}
],
"MemberId": [
"mem-tencent-te"
],
"Sort": "desc",
"Limit": 10,
"Offset": 0
}
输出示例
{
"Response": {
"Analysis": false,
"AnalysisRecords": [
"{\"level\":\"INFO\",\"count\":1}"
],
"AnalysisResults": [
{
"Data": [
{
"Key": "level",
"Value": "INFO"
}
]
}
],
"ColNames": [
"level"
],
"Columns": [
{
"Name": "level",
"Type": "text"
}
],
"Context": "mock-context",
"ListOver": true,
"Results": [
{
"FileName": "/var/log/mock.log",
"HighLights": [
{
"Key": "msg",
"Values": [
"mock"
]
}
],
"HostName": "mock-host",
"IndexStatus": "Success",
"LogJson": "{\"level\":\"INFO\",\"msg\":\"mock log\"}",
"PkgId": "mock-pkg-id",
"PkgLogId": "0",
"RawLog": "mock raw log",
"Source": "127.0.0.1",
"Time": 1715692800000,
"TopicId": "mock-topic-251308491",
"TopicName": "mock-topic-251308491"
}
],
"SamplingRate": 1,
"Topics": {
"Errors": [
{
"ErrorCodeStr": "MockError",
"ErrorMsg": "mock error message",
"TopicId": "mock-topic-251308491"
}
],
"Infos": [
{
"Context": "mock-context",
"Period": 7,
"TopicId": "mock-topic-251308491"
}
]
},
"RequestId": "b7423c66-9780-4a31-9190-f493c64a81b7"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
| FailedOperation | 操作失败。 |
| FailedOperation.DasbAmountNotEnough | FailedOperation.DasbAmountNotEnough |
| FailedOperation.DasbErrorCode | FailedOperation.DasbErrorCode |
| FailedOperation.DasbInvalidSecretId | FailedOperation.DasbInvalidSecretId |
| FailedOperation.DasbInvalidSecretKey | FailedOperation.DasbInvalidSecretKey |
| InternalError | 内部错误。 |
| InvalidFilter | 无效的过滤器 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.DecryptError | Decrypt error |
| InvalidParameter.ResourceId | InvalidParameter.ResourceId |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.SQLQueryFailed | SQL 查询失败 |
| LimitExceeded | 超过配额限制。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| RegionError | 地域错误 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| ResourceInUse | 资源被占用。 |
| ResourceInsufficient | 资源不足。 |
| ResourceInsufficient.LogAnalysisQuantityInsufficient | 日志分析量不足 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable | 资源不可用。 |
| ResourcesSoldOut | 资源售罄。 |
| UnauthorizedOperation | 未授权操作。 |
| UnauthorizedOperation.CloudAudit | 未授权操作“操作审计”产品 |
| UnauthorizedOperation.Cos | 未授权操作“对象存储”产品 |
| UnauthorizedOperation.NoPermission | UnauthorizedOperation.NoPermission |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |