All Products
Search
Document Center

Security Center:ListFileProtectPluginStatus

Last Updated:Nov 25, 2024

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-sas:ListFileProtectPluginStatuslist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SwitchIdstringNo

The ID of the core file monitoring rule.

FILE_PROTECT_RULE_SWITCH_TYPE_1693474122927
PageSizelongNo

The number of entries per page.

10
CurrentPagelongNo

The page number.

1

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

60F289EC-BAA3-5DF1-8476-B3F05A14EBC2
PageInfoobject

The pagination information.

CurrentPageinteger

The page number.

1
PageSizeinteger

The number of entries per page.

20
TotalCountinteger

The total number of entries returned.

149
Dataarray<object>

The data returned if the call is successful.

dataobject
Installedboolean

Indicates whether the Security Center agent is installed.

true
Onlineboolean

Indicates whether the Security Center agent is online. Valid value:

  • true
  • false
true
SupportFileboolean

Indicates whether the core file monitoring file is supported.

true
InstallCodestring

The returned code after you install the Security Center agent. Valid values:

  1. 0: The installation is successful.
  2. -2: The kernel does not support the installation.
-2
InstallMessagestring

The returned message after you install the Security Center agent.

driver file not exist
ClientVersionstring

The version of the Security Center agent.

00_41
Uuidstring

The UUID of the asset.

6690a46c-0edb-4663-a641-3629d1a9****
InternetIpstring

The public IP address that is associated with the instance.

172.16.XX.XX
IntranetIpstring

The private IP address that is associated with the instance.

10.42.XX.XX
InstanceNamestring

The name of the instance.

i-wz92q7m5hsbgfhdss***
Platformstring

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 codeError codeError messageDescription
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

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

Change history

Change timeSummary of changesOperation
2024-09-02The response structure of the API has changedView Change Details