获取快速检索列表
最近更新时间: 2026-09-17 00:02:46
1. 接口描述
接口请求域名: cwp.api3.fincloud.tencent.cn。
获取快速检索列表
默认接口请求频率限制:20次/秒。
接口更新时间:2023-02-09 16:57:20。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:DescribeSearchTemplates |
| Version | 是 | 否 | String | 公共参数,本接口取值:2018-02-28 |
| Region | 是 | 否 | String | 公共参数,地域信息本接口不需要传递此参数。 |
| Limit | 否 | 否 | Uint64 | 返回数量,默认为10,最大值为100。 示例值: 10 |
| Offset | 否 | 否 | Uint64 | 偏移量,默认为0。 示例值: 0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| List | Array of SearchTemplate | 模板列表 示例值:查看 |
| TotalCount | Uint64 | 总数 示例值: 1 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| MissingParameter | 缺少参数错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
5. 示例
示例1 获取快速检索列表
输入示例
https://cwp.api3.fincloud.tencent.cn/?Action=DescribeSearchTemplates
&Offset=0
&Limit=10
&<Public request parameters>
输出示例
{
"Response": {
"TotalCount": 2,
"List": [
{
"Id": 17,
"Name": "ashkd",
"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/city1\",\"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": "ndkshjs",
"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/city1\",\"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"
}
}