tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

EditBashRules

Last updated: 2024-12-06 15:41:11

1. API Description

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

This API is used to add or modify high-risk command 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: EditBashRules.
Version Yes String Common Params. The value used for this API: 2018-02-28.
Region No String Common Params. This parameter is not required.
Id No Integer Rule ID (leave this parameter blank for addition)
Uuids.N No Array of String Client ID array
HostIp No String Host IP address
Name No String Rule name, which cannot be modified during editing
Level No Integer Risk level (0: none; 1: high-risk; 2: medium-risk; 3: low-risk)
Rule No String Regular expression, which cannot be modified during editing. Apply the QueryEscape function to the content and then perform Base64 encoding.
IsGlobal No Integer Whether the rule is global. 1: global; 0: not global (default value).
White No Integer 0: blocklist; 1: allowlist
EventId No Integer When it is added to the allowlist, the event ID needs to be passed in.
DealOldEvents No Integer Whether to add existing events to the allowlist. 0: no; 1: yes.

3. Output Parameters

Parameter Name Type Description
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 Adding/Modifying High-Risk Command Rules

This example shows you how to add/modify high-risk command rules. The previous EditBashRule only supported users to enter a single IP to add or modify high-risk command rules, while the EditBashRules API supports selecting multiple servers.

Input Example

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

{
    "Name": "test",
    "Level": 1,
    "Rule": ".*",
    "IsGlobal": 0,
    "Uuids": [
        "uuids1",
        "uuids2"
    ]
}

Output Example

{
    "Response": {
        "RequestId": "354f4ac3-8546-4516-8c8a-69e3ab73aa8a"
    }
}

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.IpNoValid The IP format is invalid.
InvalidParameter.MissingParameter Missing parameter.
InvalidParameter.ParsingError Incorrect parameter parsing.
InvalidParameter.RegexRuleError The regular expression parameter format is incorrect.
InvalidParameter.RuleHostipErr Rule-based API with incorrect host IPs.
InvalidParameterValue Invalid parameter value.
MissingParameter Missing parameter error.
ResourceNotFound The resource does not exist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy