Use ListFileProtectPluginStatus to query the status of the core file monitoring plugin - Security Center

Retrieves information about the Security Center agent installed on servers on which core file monitoring rules take effect. The information includes the installation status of the Security Center agent and whether the core file monitoring feature is supported.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SwitchId	string	No	The ID of the core file monitoring rule.	FILE_PROTECT_RULE_SWITCH_TYPE_1693474122927
PageSize	integer	No	The number of entries per page.	10
CurrentPage	integer	No	The page number.	1

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	60F289EC-BAA3-5DF1-8476-B3F05A14EBC2
PageInfo	object	The pagination information.
CurrentPage	integer	The page number.	1
PageSize	integer	The number of entries per page.	20
TotalCount	integer	The total number of entries returned.	149
Data	array<object>	The data returned if the call is successful.
	object
Installed	boolean	Indicates whether the Security Center agent is installed.	true
Online	boolean	Indicates whether the Security Center agent is online. Valid value: true false	true
SupportFile	boolean	Indicates whether the core file monitoring file is supported.	true
InstallCode	string	The returned code after you install the Security Center agent. Valid values: 0: The installation is successful. -2: The kernel does not support the installation.	-2
InstallMessage	string	The returned message after you install the Security Center agent.	driver file not exist
ClientVersion	string	The version of the Security Center agent.	00_41
Uuid	string	The UUID of the asset.	6690a46c-0edb-4663-a641-3629d1a9****
InternetIp	string	The public IP address that is associated with the instance.	172.16.XX.XX
IntranetIp	string	The private IP address that is associated with the instance.	10.42.XX.XX
InstanceName	string	The name of the instance.	i-wz92q7m5hsbgfhdss***
Platform	string	The type of the operating system. Valid values: windows: Windows linux: Linux	linux

Examples

Success response

JSON format

{
  "RequestId": "60F289EC-BAA3-5DF1-8476-B3F05A14EBC2",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 149
  },
  "Data": [
    {
      "Installed": true,
      "Online": true,
      "SupportFile": true,
      "InstallCode": "-2",
      "InstallMessage": "driver file not exist",
      "ClientVersion": "00_41",
      "Uuid": "6690a46c-0edb-4663-a641-3629d1a9****",
      "InternetIp": "172.16.XX.XX",
      "IntranetIp": "10.42.XX.XX",
      "InstanceName": "i-wz92q7m5hsbgfhdss***",
      "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.