Release Notes and Announcements

Release Notes

Announcements

Getting Started

Product Introduction

Overview

Advantages

Basic Concepts

Scenarios

Associated Products

Features in Different Editions

Purchase Guide

Purchase Security Protection Licenses

Purchasing Log Analysis Service

Quick Start

Operation Guide

Security Dashboard

Asset Overview

Server List

Asset Fingerprint

Vulnerability Management

Baseline Management

Malicious File Scan

Unusual Login

Password Cracking

Malicious Requests

High-risk Commands

Local Privilege Escalation

Reverse Shell

Java Webshell

Critical File Monitor

Network Attack

A Ransomware Defense

Log Analysis

License Management

Alarm Setting

Cloud Access Management

Hybrid Cloud Installation Guide

FAQs for Beginners

Cloud Workload Protection Description

Feature Description

Agent Process Description

A Security Baseline Detection List

Parsing of JSON Format Alarm Data

Log Field Data Parsing

Agent Installation Guide

Security Score Overview

Practical Tutorial

Auto Fix of Vulnerabilities

Malicious File Processing

Troubleshooting

Intrusions on Linux

Intrusions on Windows

Offline Agent on Linux

Offline Agent on Windows

An Abnormal Log-in Notification

API Documentation

History

Introduction

API Category

Asset Management APIs

Virus Scanning APIs

Abnormal Log-in APIs

Password Cracking APIs

Malicious Request APIs

High-Risk Command APIs

Local Privilege Escalation APIs

Reverse Shell APIs

Vulnerability Management APIs

New Baseline Management APIs

Baseline Management APIs

Advanced Defense APIs

Security Operation APIs

Expert Service APIs

Other APIs

Overview Statistics APIs

Settings Center APIs

Making API Requests

Intrusion Detection APIs

Data Types

Error Codes

FAQs

Agreements

Service Level Agreement

Data Processing And Security Agreement

Glossary

DescribeBruteAttackList

PDF

Focus Mode

Font Size

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

1. API Description

Domain name for API request: cwp.intl.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.intl.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

Tencent Cloud CLI 3.0

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.

Help and Support

Was this page helpful?

You can also Contact sales or Submit a Ticket for help.

Help us improve! Rate your documentation experience in 5 mins.

Feedback

tencent cloud

Cloud Workload Protection Platform