tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeSearchTemplates

Last updated: 2024-12-06 15:39:44

1. API Description

Domain name for API request: cwp.intl.tencentcloudapi.com.

This API is used to obtain the list of quick retrievals.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeSearchTemplates.
Version Yes String Common Params. The value used for this API: 2018-02-28.
Region No String Common Params. This parameter is not required.
Offset No Integer Offset, which is 0 by default.
Limit No Integer Quantity of returns. It is 10 by default, and the maximum value is 100.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total number
List Array of SearchTemplate Template list
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Access the quick retrieval list.

Input Example

https://cwp.intl.tencentcloudapi.com/?Action=DescribeSearchTemplates
&Offset=0
&Limit=10
&<Common request parameters>

Output Example

{
    "Response": {
        "TotalCount": 2,
        "List": [
            {
                "Id": 17,
                "Name": "kbtest",
                "LogType": "malware",
                "Condition": "src_ip matched characters: 193.27.228.98",
                "TimeRange": "2020-07-31 00:00:00 to 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\":\"matched characters\",\"like\":\"fuzzily matched characters\",\"not\":\"characters not contained\",\"is_one_of\":\"matches any of the following characters\",\"not_one_of\":\"any of the following characters not contained\"},\"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 matched characters: 10.0.0.1",
                "TimeRange": "2020-06-13 00:00:00 to 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\":\"matched characters\",\"like\":\"fuzzily matched characters\",\"not\":\"characters not contained\",\"is_one_of\":\"matches any of the following characters\",\"not_one_of\":\"any of the following characters not contained\"},\"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. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError Internal error
InvalidParameter Incorrect parameter.
InvalidParameterValue Invalid parameter value.
MissingParameter Missing parameter error.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy