All Products
Search
Document Center

Security Center:CreateFileProtectClientRule

Last Updated:Jun 12, 2026

Creates a file protection rule.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

RuleName

string

Yes

The name of the rule.

规则****

ProcPaths

array

Yes

The list of process monitoring paths. Wildcards are supported.

string

No

The process monitoring path. Wildcards are supported.

/usr/local/*

FilePaths

array

Yes

The list of monitored file paths. Wildcards are supported.

string

No

The monitored file path. Wildcards are supported.

/usr/*

FileOps

array

Yes

The list of operations performed on files.

string

No

The list of operations performed on files.

WRITE

FileTypes

array

No

The list of monitored file types.

string

No

The monitored file type.

txt

RuleAction

string

Yes

The action to take when the policy is hit. Valid values:

  • monitor: Alert.

  • block: Block.

  • pass: Allow.

pass

AlertLevel

integer

No

The alert notification level. Valid values:

  • 0: no alert

  • 1: reminder

  • 2: suspicious

  • 3: high-risk.

0

SwitchId

string

No

The switch ID associated with the rule.

FILE_PROTECT_RULE_SWITCH_TYPE_0000

Status

integer

Yes

The status of the rule. Valid values:

  • 0: Disabled.

  • 1: Enabled.

0

Platform

string

No

The operating system type. Valid values:

  • windows: Windows.

  • linux: Linux.

linux

ExcludeUsers

array

No

The list of excluded users.

string

No

The excluded user.

root

ClientToken

string

No

The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

xxx

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

Id of the request

ACF97412-FD09-4D1F-994F-34DF12BREF20

Id

integer

The policy ID.

1

Examples

Success response

JSON format

{
  "RequestId": "ACF97412-FD09-4D1F-994F-34DF12BREF20",
  "Id": 1
}

Error codes

HTTP status code

Error code

Error message

Description

400 IllegalParameter Illegal parameter, please check the param. Parameter error, please check the input parameters.
500 ServerError ServerError
403 NoPermission caller has no permission You are not authorized to do this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.