tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeBruteAttackList

Last updated: 2024-08-27 11:39:11

1. API Description

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

This API is used to obtain the list of password cracking.

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: DescribeBruteAttackList.
Version Yes String Common Params. The value used for this API: 2018-02-28.
Region No String Common Params. This parameter is not required.
Limit No Integer Number of items to be returned. The maximum value is 100.
Offset No Integer Offset, which defaults to 0
Filters.N No Array of Filter Filter criteria
  • IpOrAlias - String - required: no - filter by host IP or alias
  • Uuid - String - required: no - CWPP unique UUID
  • Quuid - String - required: no - CVM UUID
  • Status - String - required: no - filter by status: failed - FAILED; succeeded - SUCCESS
  • UserName - String - required: no - filter by UserName
  • SrcIp - String - required: no - filter by source IP
  • CreateBeginTime - String - required: no - filter by first attack time, start time
  • CreateEndTime - String - required: no - filter by first attack time, end time
  • ModifyBeginTime - String - required: no - filter by last attack time, start time
  • ModifyEndTime - String - required: no - filter by last attack time, end time
  • Banned - String - required: no - filter by blocking status (separate multiple items with commas): 0 - not blocked (global ZK switch is off); 82 - not blocked (Non-Pro Edition); 83 - not blocked (allowlisted); 1 - blocked; 2 - not blocked (abnormal program); 3 - not blocked (private network attacks cannot be blocked); 4 - not blocked (Anping is not supported)
    		•
    Order No String Sorting method: sort by number of requests: asc - ascending order/desc - descending order
    By No String Sorting field: CreateTime - first attack time

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Total number
    Note: This field may return null, indicating that no valid values can be obtained.
    BruteAttackList Array of BruteAttackInfo List of password cracking attacks
    Note: This field may return null, indicating that no valid values can be obtained.
    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 Obtaining a Password Cracking List

    This example shows you how to obtain the password cracking list.

    Input Example

    POST / HTTP/1.1
Host: cwp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBruteAttackList
<Common request parameters>

{
    "Limit": 1,
    "Filters": [
        {
            "Values": [
                "abc"
            ],
            "Name": "abc",
            "ExactMatch": true
        }
    ],
    "Offset": 1
}

    Output Example

    {
    "Response": {
        "BruteAttackList": [
            {
                "Id": 202008000000971,
                "Uuid": "c2972dd6-165e-11ea-95eb-40f2e9f5667a",
                "MachineIp": "10.104.135.28",
                "MachineName": "poc test-debian9",
                "UserName": "root",
                "SrcIp": "117.146.173.98",
                "Status": "FAILED",
                "EventType": 200,
                "Country": 1,
                "City": 334,
                "Province": 31,
                "CreateTime": "2020-02-21 16:35:49",
                "BanStatus": 82,
                "Count": 1098,
                "InstanceId": "ins-xxx"
            }
        ],
        "RequestId": "4234234",
        "TotalCount": 25328
    }
}

    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.
    InvalidParameter.DateRange Incorrect time range format.
    InvalidParameter.MissingParameter Missing parameter.
    InvalidParameter.ParsingError Incorrect parameter parsing.
    InvalidParameterValue Invalid parameter value.
    MissingParameter Missing parameter error.
    ResourceNotFound The resource does not exist.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy