tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

DescribeBlockIgnoreList

最后更新时间：2023-05-05 09:39:09

1. API Description

Domain name for API request: cfw.tencentcloudapi.com.

This API is used to get allowlists or blocklists for intrusion prevention.

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: DescribeBlockIgnoreList.
Version Yes String Common Params. The value used for this API: 2019-09-04.
Region No String Common Params. This parameter is not required for this API.
Limit Yes Integer Number of entries per page.
Offset Yes Integer Page offset.
Direction Yes String Direction. Valid values: 1: inbound public access; 0: outbound public access; 3: private network access; empty string: all access.
RuleType Yes Integer Rule type. Valid values: 1: block; 2: allow.
Order Yes String Column by which rules are sorted. Valid values: EndTime: end time; StartTime: start time; MatchTimes: number of matching times.
By Yes String Sort order. Valid values: desc: descending; asc: ascending.
SearchValue No String Search keys, in a JSON string. Valid values: {}: empty; domain: domain name; level: threat level; ignore_reason: reason for allowing access; rule_source: source of a security event; address: geographical location; common: fuzzy search.

3. Output Parameters

Parameter Name Type Description
Data Array of BlockIgnoreRule List data.
Total Integer Total number of results, which is used for pagination.
ReturnCode Integer Status code. Valid values: 0: successful; others: failed.
ReturnMsg String Status message. Valid values: success: successful query; fail: failed query.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting the honeypot service list

This example shows you how to get the honeypot service list.

Input Example

POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBlockIgnoreList
<Common Request Parameters>

{
    "Direction": "xx",
    "SearchValue": "xx",
    "RuleType": 1,
    "By": "xx",
    "Limit": 10,
    "Offset": 0,
    "Order": "xx"
}

Output Example

{
    "Response": {
        "ReturnMsg": "xx",
        "ReturnCode": 0,
        "Data": [
            {
                "Domain": "xx",
                "Protocol": "xx",
                "UniqueId": "xx",
                "Level": "xx",
                "Country": "xx",
                "Direction": 0,
                "EventName": "xx",
                "Source": "xx",
                "MatchTimes": 0,
                "StartTime": "xx",
                "Address": "xx",
                "Action": 0,
                "EndTime": "xx",
                "Ioc": "xx",
                "IgnoreReason": "xx"
            }
        ],
        "RequestId": "xx",
        "Total": 1
    }
}

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
FailedOperation Operation failed.
InternalError Internal error.
InvalidParameter Invalid parameter.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
隐私条款服务条款缓存条款