ListFileProtectClientRule - Security Center - Alibaba Cloud Documentation Center

Retrieves the list of file protection rules.

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:ListFileProtectClientRule

list

*FileProtectClientRule

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

None

Request parameters

Parameter	Type	Required	Description	Example
PageSize	integer	No	The maximum number of entries per page for a paged query.	20
CurrentPage	integer	No	The page number of the current page in a paged query.	1
RuleName	string	No	The rule name.	tetsRule
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
RuleAction	string	No	The rule action. Valid values: block: Block. monitor: Monitor. pass: Allow.	pass
Platform	string	No	The operating system type. Valid values: windows: Windows linux: Linux	linux

Response elements

Element	Type	Description	Example
	object
FileProtectList	array<object>	The returned data list.
	object	The returned data list.
AlertLevel	integer	The alert notification level. Valid values: 0: no alert 1: reminder 2: suspicious 3: high-risk	0
EffectInstanceCount	integer	The total number of affected assets.	12
ExcludeUsers	array	The list of excluded users.
	string	The list of excluded users.	root
FileOps	array	The operations performed on files.
	string	The operation performed on files. Valid values: WRITE: write READ: read DELETE: delete RENAME: rename CHMOD: change permissions	READ
FilePaths	array	The monitored file paths.
	string	The monitored file paths.	/usr/*
FileTypes	array	The list of protected file types.
	string	The list of protected file types.	txt
GmtCreate	integer	The creation time.	1682304179000
GmtModified	integer	The most recent modification time.	1682304179000
Id	integer	The rule ID.	1412511
Platform	string	The operating system type. Valid values: windows: Windows linux: Linux	linux
ProcPaths	array	The list of monitored process paths.
	string	The list of monitored process paths.	/usr/local/*
RuleAction	string	The action that the rule performs on the client. Valid values: monitor: alert block: block pass: allow	pass
RuleName	string	The rule name.	test11
Status	integer	The status of the rule. Valid values: 0: disabled 1: enabled	1
SwitchId	string	The switch ID associated with the rule.	FILE_PROTECT_RULE_SWITCH_TYPE_******
PageInfo	object	The page information for a paged query.
CurrentPage	integer	The page number of the current page in a paged query.	1
PageSize	integer	The maximum number of entries displayed per page in a paged query.	10
TotalCount	integer	The total number of entries.	45
RequestId	string	The request ID. It is a unique identifier generated by Alibaba Cloud for the request and can be used to troubleshoot issues.	BA674E4B-00CF-5DEA-8B92-360862FB****

Examples

Success response

JSON format

{
  "FileProtectList": [
    {
      "AlertLevel": 0,
      "EffectInstanceCount": 12,
      "ExcludeUsers": [
        "root"
      ],
      "FileOps": [
        "READ"
      ],
      "FilePaths": [
        "/usr/*"
      ],
      "FileTypes": [
        "txt"
      ],
      "GmtCreate": 1682304179000,
      "GmtModified": 1682304179000,
      "Id": 1412511,
      "Platform": "linux",
      "ProcPaths": [
        "/usr/local/*"
      ],
      "RuleAction": "pass",
      "RuleName": "test11",
      "Status": 1,
      "SwitchId": "FILE_PROTECT_RULE_SWITCH_TYPE_******"
    }
  ],
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 10,
    "TotalCount": 45
  },
  "RequestId": "BA674E4B-00CF-5DEA-8B92-360862FB****"
}

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.