Tenant Cloud Security Cloud Workload Protection Platform Intrusion Detection - Password Cracking APIs DescribeBanMode

DescribeBanMode

Last Updated At: 2026-08-02 00:05:02

1. Interface Description

Interface request domain name: cwp.api3.convergecloud.com.

API for querying the blocking mode for brute-force attacks

Default interface request rate limit: 20 times per second.

Interface update time: 2022-05-20 15:13:13.

The interface is both signature verification and authentication.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name Required Allow NULL Type Description
Action Yes No String Public parameter, The value of this interface: DescribeBanMode
Version Yes No String Public parameter, The value of this interface: 2018-02-28
Region No No String Public parameter,Regional information This interface does not need to pass this parameter.

3. Output Parameters

Parameter name Type Description
Mode String Blocking mode. Valid values: STANDARD_MODE and DEEP_MODE.
Example: STANDARD_MODE
StandardModeConfig StandardModeConfig Standard blocking configuration.
Example:View
RequestId String Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

4. Error Code

The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

Error Code Description
InternalError Internal error.
InvalidParameter.ParsingError Parameter parsing error.
InvalidParameter.MissingParameter Missing parameter.
MissingParameter Missing parameter.
InvalidParameter Invalid parameter.
InvalidParameterValue The parameter value is invalid.