GetFileProtectRule - Security Center - Alibaba Cloud Documentation Center

Queries the information about a core file monitoring rule based on the ID of the rule.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-sas:GetFileProtectRule	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
Id	long	No	The ID of the rule.	245

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	C0DF9057-67C5-574D-A2D2-0CA9AC74C4D3
Data	object	The response parameters.
Action	string	The handling method of the rule. Valid values: pass: allow alert	pass
RuleName	string	The name of the rule.	test-000
SwitchId	string	The switch ID of the rule.	FILE_PROTECT_RULE_SWITCH_TYPE_0000
Id	long	The ID of the rule.	44616
AlertLevel	integer	The severity of alerts. Valid values: 0: does not generate alerts 1: sends notifications 2: suspicious 3: high-risk	0
FileOps	array	The operations performed on the files.
fileOps	string	The operation performed on the file. Valid values: WRITE READ DELETE RENAME CHMOD: change permissions	CHMOD
FilePaths	array	The paths to the monitored files.
filePaths	string	The path to the monitored file. Wildcard characters are supported.	/usr/*
ProcPaths	array	The paths to the monitored processes.
procPaths	string	The path to the monitored process. Wildcard characters are supported.	/usr/local/*
Status	integer	The status of the rule. Valid values: 0: disabled 1: enabled	1
Platform	string	The type of the operating system. Valid values: windows: Windows linux: Linux	linux

Examples

Sample success responses

JSONformat

{
  "RequestId": "C0DF9057-67C5-574D-A2D2-0CA9AC74C4D3",
  "Data": {
    "Action": "pass",
    "RuleName": "test-000",
    "SwitchId": "FILE_PROTECT_RULE_SWITCH_TYPE_0000",
    "Id": 44616,
    "AlertLevel": 0,
    "FileOps": [
      "CHMOD"
    ],
    "FilePaths": [
      "/usr/*"
    ],
    "ProcPaths": [
      "/usr/local/*"
    ],
    "Status": 1,
    "Platform": "linux"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
403	NoPermission	caller has no permission	You are not authorized to do this operation.
500	ServerError	ServerError	-

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-09-02	The response structure of the API has changed	View Change Details