Use GetFileProtectRule to query information about a core file monitoring rule - Security Center - Alibaba Cloud - Security Center

Queries a core file monitoring rule by rule ID.

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

get

*ClientFileProtect

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

None

Request parameters

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

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The request ID.	C0DF9057-67C5-574D-A2D2-0CA9AC74C4D3
Data	object	The returned data.
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	integer	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.
	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.
	string	The path to the monitored file. Wildcard characters are supported.	/usr/*
ProcPaths	array	The paths to the monitored processes.
	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

Success response

JSON format

{
  "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
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.