Tenant Cloud
Security
Cloud Workload Protection Platform
Intrusion Detection - Password Cracking APIs
DescribeBanStatus
1. Interface Description
Interface request domain name: cwp.api3.convergecloud.com.
API for querying the blocking status
Default interface request rate limit: 20 times per second.
Interface update time: 2022-05-20 15:12:33.
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: DescribeBanStatus |
| 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 |
|---|---|---|
| OpenSmartMode | Bool | Whether to enable intelligent over-allowing mode Example: true |
| ShowTips | Bool | Indicates whether to display a pop-up message. false: does not display a pop-up message. true: displays a pop-up message. Example: false |
| Status | Uint64 | Blocking switch status: 0 - off. 1 - advanced blocking. 2 - basic blocking (only blocklisted IP addresses in the intelligence database will be blocked). Example: 1 |
| 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. |
| InvalidParameter.InvalidFormat | Incorrect parameter format. |
| MissingParameter | Missing parameter. |
| ResourceNotFound | The resource does not exist. |
| InvalidParameter | Invalid parameter. |
| InvalidParameterValue | The parameter value is invalid. |