ListFileProtectPluginStatus - Security Center - Alibaba Cloud Documentation Center

Queries 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.

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:ListFileProtectPluginStatus	list	All Resources *	none	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	long	No	The number of entries per page.	10
CurrentPage	long	No	The page number.	1

Response parameters

Parameter	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.
data	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

Sample success responses

JSONformat

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