CheckBashRuleParams

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

1. Interface Description

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

This API is used to check the parameters that you use to create or modify a custom anti-high-risk command rule.

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: CheckBashRuleParams
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.
CheckField Yes No String Name or rule of the check content. If both need to be checked, separate them with commas (,).
Example: Name,Rule
EventId No No Uint64 ID of the event required for adding allowlist entries in the event list.
Example: 10003
Id No No Uint64 Rule ID required for the modification.
Example: 3680
Name No No String Rule name.
Example: Rule 1
Rule No No String Regular expression, which must match the command corresponding to the specified event ID.
Example: rm -rf /tmp/tmp

3. Output Parameters

Parameter name Type Description
ErrCode Uint64 0: the check is passed. 1: the rule name has failed the check. 2: failed to pass the regular expression check.
Example: 2
ErrMsg String Error message.
Example: OK
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.
InvalidParameter Invalid parameter.