Tenant Cloud Security Cloud Workload Protection Platform Intrusion Detection - Malicious Request APIs DescribeMaliciousRequestWhiteList

DescribeMaliciousRequestWhiteList

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

1. Interface Description

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

API for querying the allowlist of the Anti-Malicious Requests feature

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: DescribeMaliciousRequestWhiteList
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.
By No No String Sorting field. Valid values: CreateTime and LatestScanTime.
Example: CreateTime
Filters No No Array of Filters Filter conditions.

  • Domain - String - Base64-encoded domain name.

    • Example:View
    Limit Yes No Uint64 Number of items returned. The default value is 10, and the maximum value is 100.
    Example: 10
    Offset Yes No Uint64 Offset. Default value: 0.
    Example: 0
    Order No No String Sorting Method: [ASC: Ascending Order, DESC: Descending Order]
    Example: ASC

    3. Output Parameters

    Parameter name Type Description
    List Array of MaliciousRequestWhiteListInfo Allowlist information.
    Example:View
    TotalCount Uint64 Total number of records returned for the paginated query.
    Example: 10
    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.
    InvalidParameter Invalid parameter.
    InvalidParameterValue The parameter value is invalid.