Query core file monitoring rules - Security Center - Alibaba Cloud - Security Center

Retrieves the list of rules for the core file protection feature.

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

list

*ClientFileProtect

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

None

Request parameters

Parameter	Type	Required	Description	Example
PageSize	integer	No	The maximum number of entries per page in a paging query.	10
CurrentPage	integer	No	The page number of the current page in a paging query.	1
RuleName	string	No	The name of the rule.	test-rule-1
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 action of the rule on the client. Valid values: pass: allow alert: alert	pass
Platform	string	No	The operating system type. Valid values: windows: Windows linux: Linux	linux

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID, which is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.	FBBEB173-1F43-505F-A876-C03ECDF6CE4C
PageInfo	object	The paging information for the query.
CurrentPage	integer	The page number of the current page in a paging query.	1
PageSize	integer	The maximum number of entries per page in a paging query.	20
TotalCount	integer	The total number of entries returned.	253
FileProtectList	array<object>	The list of returned data.
	object	The list of returned data.
Status	integer	The status of the rule. Valid values: 0: disabled 1: enabled	1
AlertLevel	string	The alert notification level. Valid values: 0: No alert. 1: Reminder. 2: Suspicious. 3: High-risk.	0
SwitchId	string	The switch ID of the rule.	FILE_PROTECT_RULE_SWITCH_TYPE_1693474122927
Id	integer	The rule ID.	1412511
FileOps	array	The list of operations performed on files.
	string	The operation performed on a file. Valid values: WRITE: write READ: read DELETE: delete RENAME: rename CHMOD: change permissions	READ
Action	string	The action of the rule on the client. Valid values: pass: allow alert: alert	pass
FilePaths	array	The list of monitored file paths. Wildcards are supported.
	string	The monitored file path.	/usr/*
ProcPaths	array	The list of monitored process paths. Wildcards are supported.
	string	The monitored process path.	/usr/local/*
RuleName	string	The rule name.	test11
GmtCreate	integer	The creation time.	1682304179000
GmtModified	integer	The most recent modification time.	1682304179000
EffectInstanceCount	integer	The total number of affected assets.	12
Platform	string	The operating system type. Valid values: windows: Windows linux: Linux	linux

Examples

Success response

JSON format

{
  "RequestId": "FBBEB173-1F43-505F-A876-C03ECDF6CE4C",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 253
  },
  "FileProtectList": [
    {
      "Status": 1,
      "AlertLevel": "0",
      "SwitchId": "FILE_PROTECT_RULE_SWITCH_TYPE_1693474122927",
      "Id": 1412511,
      "FileOps": [
        "READ"
      ],
      "Action": "pass",
      "FilePaths": [
        "/usr/*"
      ],
      "ProcPaths": [
        "/usr/local/*"
      ],
      "RuleName": "test11",
      "GmtCreate": 1682304179000,
      "GmtModified": 1682304179000,
      "EffectInstanceCount": 12,
      "Platform": "linux"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
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.