1. 接口描述
接口请求域名： cwp.tencentcloudapi.com 。
添加检索模板
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateSearchTemplate。 |
| Version | 是 | String | 公共参数，本接口取值：2018-02-28。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| SearchTemplate | 是 | SearchTemplate | 搜索模板 示例值：{"Condition": "count \u7b49\u4e8e\u6570\u503c", "DisplayData": "[{"id":369266774838,"patternsField":"count","selectedtype":"is","selectedOptionsMap":{"is":"\u7b49\u4e8e\u6570\u503c","not":"\u4e0d\u7b49\u4e8e\u6570\u503c","is_one_of":"\u7b49\u4e8e\u4ee5\u4e0b\u4efb\u610f\u6570\u503c","not_one_of":"\u4e0d\u7b49\u4e8e\u4ee5\u4e0b\u4efb\u610f\u6570\u503c","is_range":"\u5c5e\u4e8e\u6570\u503c\u533a\u95f4","not_range":"\u4e0d\u5c5e\u4e8e\u6570\u503c\u533a\u95f4"},"selectedTypeList":["is","not","is_one_of","not_one_of","is_range","not_range"],"third_cat":"input","value":"1", "Flag": "simple", "LogType": "userlog-vul|userlog-hostlogin|userlog-baseline|userlog-asset_port|userlog-network_attack|userlog-privilege_escalation|userlog-reverse_shell|userlog-bruteforce|userlog-asset_component|userlog-asset_process|userlog-risk_dns|userlog-asset_account|userlog-malware|userlog-risk_", "Name": "nOqBFVNMgONSxKmSGYZpekKdZJKFMtuGyxMcJeoMsGEIScvKeDcpSFuzHkTlEjqkGVWameNFwntVRRkEbdoDG@U", "Query": "{"index":["userlog-vul","userlog-hostlogin","userlog-baseline","userlog-asset_port","userlog-network_attack","userlog-privilege_escalation","userlog-reverse_shell","userlog-bruteforce","userlog-asset_component","userlog-asset_process","userlog-risk_dns","userlog-asset_account","userlog-malware","userlog-risk_bash"],"body":{"query":{"bool":{"filter":{"bool":{"filter":{"range":{"create_time":{"gte":1636560000000,"lte":1636646399999}}},"must":[],"must_not":[],"should":[{"term":{"count":"12"}}]}}}},"aggs":{"count_stats":{"date_histogram":{"field":"create_time","interval":"30m","time_zone":"Asia/Shanghai","min_doc_count":1}}},"highlight":{"fields":{"":{}}}},"sort":[{"create_time":"desc***", "TimeRange": "2021-11-11 00:00:00 \u81f3 2021-11-11 23:5****"} |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Status | Integer | 0：成功，非0：失败 示例值：0 |
| Message | String | 失败原因 示例值：{ "Name": "template1", "LogType": "malware", "Condition": "src_ip匹配字符:10.0.0.1", "TimeRange": "2020-06-1300:00:00至2020-07-1323: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 | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 添加检索模板
输入示例
https://cwp.tencentcloudapi.com/?Action=CreateSearchTemplate
&SearchTemplate.Name="kbtest"
&SearchTemplate.LogType="malware"
&SearchTemplate.Condition="src_ip匹配字符:10.0.0.1"
&SearchTemplate.TimeRange="2020-06-1300:00:00至2020-07-1323:59:59"
&SearchTemplate.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\"}]}"
&SearchTemplate.Flag="simple"
&SearchTemplate.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\"}]"
&<公共请求参数>输出示例
{
"Response": {
"Status": 0,
"RequestId": "49082d4a-71b4-4e32-9ca1-b33872a4a63a"
}
}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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.NameHasRepetition | 名字已重复。 |
| InvalidParameter.ParsingError | 参数解析错误。 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |
