All Products
Search

This Product

    Security Center:CreateFileProtectClientRule

    Document Center

    Security Center:CreateFileProtectClientRule

    Last Updated:Sep 07, 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

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    yundun-sas:CreateFileProtectClientRule

    create

    *FileProtectClientRule

    acs:yundun-sas:{#regionId}:{#accountId}:fileprotectclientrule/*

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RuleName

    string

    Yes

    The name of the rule.

    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.

    Valid values:

    • READ :

      Read.

    • RENAME :

      Rename.

    • DELETE :

      Delete.

    • CHMOD :

      Modify permissions.

    • WRITE :

      Write.

    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.

    Valid values:

    • pass :

      Allow.

    • block :

      Block.

    • monitor :

      Alert.

    pass
    AlertLevel

    integer

    No

    The alert notification level. Valid values:

    • 0: No alert.

    • 1: Reminder.

    • 2: Suspicious.

    • 3: High-risk.

    Valid values:

    • 0 :

      No alert.

    • 1 :

      Reminder.

    • 2 :

      Suspicious.

    • 3 :

      High-risk.

    0
    SwitchId

    string

    No

    The switch ID that corresponds to the rule.

    FILE_PROTECT_RULE_SWITCH_TYPE_0000
    Status

    integer

    Yes

    The rule status. Valid values:

    • 0: Disabled.

    • 1: Enabled.

    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.