容器安全服务
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 容器安全服务 > API 文档 > 安全运营-日志分析 相关接口 > 获取快速检索列表

获取快速检索列表

最近更新时间：2024-03-12 01:52:07

我的收藏

本页目录：

1. 接口描述

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

获取快速检索列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeSearchTemplates。
Version 是 String 公共参数，本接口取值：2020-11-01。
Region 否 String 公共参数，此参数为可选参数。
Offset 否 Integer 偏移量，默认为0。
示例值：1
Limit 否 Integer 返回数量，默认为10，最大值为100。
示例值：10

3. 输出参数

参数名称 类型 描述
TotalCount Integer 总数
示例值：1
List Array of SearchTemplate 模板列表
示例值：[]
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取快速检索列表

输入示例

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

{
    "Offset": 0,
    "Limit": 10
}

输出示例

{
    "Response": {
        "TotalCount": 2,
        "List": [
            {
                "Id": 17,
                "Name": "kbtest",
                "LogType": "malware",
                "Condition": "src_ip 匹配字符: 193.27.228.98",
                "TimeRange": "2020-07-31 00:00:00 至 2020-07-31 23:59:59",
                "Query": "{\"index\":[\"malware\"],\"body\":{\"query\":{\"bool\":{\"filter\":{\"bool\":{\"filter\":{\"range\":{\"timestamp\":{\"gte\":1596124800000,\"lte\":1596211199999}}},\"must\":[{\"term\":{\"src_ip\":\"193.27.228.98\"}}],\"must_not\":[],\"should\":[]}}}},\"aggs\":{\"count_stats\":{\"date_histogram\":{\"field\":\"timestamp\",\"interval\":\"30m\",\"time_zone\":\"Asia/Shanghai\",\"min_doc_count\":1}}},\"highlight\":{\"fields\":{\"*\":{}}}},\"sort\":[{\"timestamp\":\"desc\"}]}",
                "Flag": "simple",
                "DisplayData": "[{\"id\":14401398135,\"patternsField\":\"src_ip\",\"selectedtype\":\"is\",\"selectedOptionsMap\":{\"is\":\"匹配字符\",\"like\":\"模糊匹配字符\",\"not\":\"不包含字符\",\"is_one_of\":\"匹配以下任意字符\",\"not_one_of\":\"不包含以下任意字符\"},\"selectedTypeList\":[\"is\",\"like\",\"not\",\"is_one_of\",\"not_one_of\"],\"third_cat\":\"input\",\"value\":\"193.27.228.98\"}]"
            },
            {
                "Id": 13,
                "Name": "test",
                "LogType": "malware",
                "Condition": "src_ip 匹配字符: 10.0.0.1",
                "TimeRange": "2020-06-13 00:00:00 至 2020-07-13 23:59:59",
                "Query": "{\"index\":[\"malware\"],\"body\":{\"query\":{\"bool\":{\"filter\":{\"bool\":{\"filter\":{\"range\":{\"timestamp\":{\"gte\":1591977600000,\"lte\":1594655999999}}},\"must\":[{\"term\":{\"src_ip\":\"10.0.0.1\"}}],\"must_not\":[],\"should\":[]}}}},\"aggs\":{\"count_stats\":{\"date_histogram\":{\"field\":\"timestamp\",\"interval\":\"12h\",\"time_zone\":\"Asia/Shanghai\",\"min_doc_count\":1}}},\"highlight\":{\"fields\":{\"*\":{}}}},\"sort\":[{\"timestamp\":\"desc\"}]}",
                "Flag": "simple",
                "DisplayData": "[{\"id\":449375484687,\"patternsField\":\"src_ip\",\"selectedtype\":\"is\",\"selectedOptionsMap\":{\"is\":\"匹配字符\",\"like\":\"模糊匹配字符\",\"not\":\"不包含字符\",\"is_one_of\":\"匹配以下任意字符\",\"not_one_of\":\"不包含以下任意字符\"},\"selectedTypeList\":[\"is\",\"like\",\"not\",\"is_one_of\",\"not_one_of\"],\"third_cat\":\"input\",\"value\":\"10.0.0.1\"}]"
            }
        ],
        "RequestId": "252ab6a8-3d45-414d-a31e-fb668e99864c"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InternalError.MainDBFail 操作数据库失败。
InvalidParameter 参数错误。
中国站