Tenant Cloud Security Cloud Workload Protection Platform Intrusion Detection - High-Risk Command APIs DescribeBashEvents

DescribeBashEvents

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

1. Interface Description

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

API for querying high-risk commands

Default interface request rate limit: 20 times per second.

Interface update time: 2022-06-06 14:53:54.

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: DescribeBashEvents
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 Field for sorting. CreateTime: occurrence time. ModifyTime: processing time.
Example: CreateTime
Filters No No Array of Filter Filtering conditions.

  • HostName - String - required: no - host name.

  • Hostip - String - required: no - host's private IP address.

  • RuleCategory - Int - required: no - policy type (all types or a single type): 0: system; 1: user.

  • RuleName - String - required: no - policy name.

  • RuleLevel - Int - required: no - threat level (multiple levels supported).

  • Status - Int - required: no - processing status (multiple statuses supported): 0: pending; 1: processed; 2: allowlisted; 3: ignored; 4: deleted; 5: blocked.

  • DetectBy - Int - required: no - data source (multiple sources supported): 0: bash logs; 1: real-time monitoring.

  • StartTime - String - required: no - start time.

  • EndTime - String - required: no - end time.

    • Example:View
    Limit No No Uint64 Number of items returned. The default value is 10, and the maximum value is 100.
    Example: 10
    Offset No No Uint64 Offset. Default value: 0.
    Example: 0
    Order No No String Sorting order. asc: ascending order. desc: descending order.
    Example: asc

    3. Output Parameters

    Parameter name Type Description
    List Array of BashEvent List of high-risk command events.
    Example:View
    TotalCount Uint64 Total number.
    Example: 1021
    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.IllegalRequest Invalid request.
    InvalidParameter Invalid parameter.
    InvalidParameterValue The parameter value is invalid.