tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CheckBashRuleParams

Last updated: 2024-08-27 11:42:35

1. API Description

Domain name for API request: cwp.tencentcloudapi.com.

This API is used to verify parameters entered for adding and editing high-risk command user rules.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: CheckBashRuleParams.
Version Yes String Common Params. The value used for this API: 2018-02-28.
Region No String Common Params. This parameter is not required.
CheckField Yes String Verify content Name or Rule. (Use a comma to separate them if both need to be verified.)
EventId No Integer Event ID needs to be submitted when allowlisting an event in the event list.
Name No String Name of rule to be entered
Rule No String The regular expression to be entered by the user: It must match command content corresponding to the submitted EventId.
Id No Integer Rule ID passed during editing

3. Output Parameters

Parameter Name Type Description
ErrCode Integer 0: verification passed; 1: rule name verification failed; 2: regular expression verification failed.
ErrMsg String Verification information
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Example

Input Example

POST / HTTP/1.1
Host: cwp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CheckBashRuleParams
<Common request parameters>

{
    "Rule": "rm -rf /tmp/tmp\\.ERYbwgd8e9",
    "Name": "mapleaa",
    "EventId": 1098230,
    "CheckField": "Name,Rule"
}

Output Example

{
    "Response": {
        "RequestId": "d92d723e-4aac-4f4a-bbf9-e5430e29d289",
        "ErrCode": 2,
        "ErrMsg": "The regular expression does not match the command content."
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError Internal error
InvalidParameter Incorrect parameter.
InvalidParameter.InvalidFormat Incorrect parameter format.
InvalidParameter.MissingParameter Missing parameter.
InvalidParameter.ParsingError Incorrect parameter parsing.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy