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

DescribeBanWhiteList

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

1. Interface Description

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

API for querying a blocklist

Default interface request rate limit: 20 times per second.

Interface update time: 2022-05-20 15:11:35.

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: DescribeBanWhiteList
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.
Filters No No Array of Filter Filter condition.
  • Keywords - String - Required: no - query keywords. 

    • Example:View
    Limit No No Uint64 Maximum number of entries to return. Maximum value: 100.
    Example: 10
    Offset No No Uint64 Offset. Default value: 0.
    Example: 0

    3. Output Parameters

    Parameter name Type Description
    TotalCount Uint64 Total number of records.
    Example: 4
    WhiteList Array of BanWhiteListDetail Allowlist list.
    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.
    InvalidParameter.InvalidFormat Incorrect parameter format.
    MissingParameter Missing parameter.
    ResourceNotFound The resource does not exist.
    InvalidParameter Invalid parameter.
    InvalidParameterValue The parameter value is invalid.