Query plugin information on a server via ListPluginForUuid - Security Center - Alibaba Cloud - Security Center

Query plugin information of an asset.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Uuid	string	Yes	The UUID of the server. Note You can call the DescribeCloudCenterInstances operation to obtain this parameter.	bdb7071f-129d-4ceb-af80-4cf70c4571c6
Types	array	No	The list of plugin types.
	string	No	The plugin type. Valid values: auto_breaking: antivirus type ransomware_breaking: anti-ransomware (bait capture) webshell_cloud_breaking: website backdoor connection defense alisecguard: client self-protection alinet: malicious network behavior defense	auto_breaking

Response elements

Element	Type	Description	Example
	object	The data returned by the request.
RequestId	string	The ID of this request, which is a unique identifier generated by Alibaba Cloud for the request. It can be used for troubleshooting and problem locating.	7E0618A9-D5EF-4220-9471-C42B5E92719F
AegisUuidTargetPluginConfigList	array<object>	The list of plugin information.
	array<object>	The plugin information.
PluginName	string	The name of the plugin type. Valid values: alihips: performs virus and trojan protection alisecguard: performs attack protection alinet: protects against network-side attacks on the server	alisecguard
PluginOnlineInstalled	boolean	Indicates whether the plugin is installed. Valid values: true: installed false: not installed	true
PluginOnlineStatus	boolean	Indicates whether the plugin is online. Valid values: true: online false: offline	true
PluginInstallCode	string	The installation code of the plugin instance.	k5O5nd
PluginVersion	string	The plugin version.	00_10
AegisSuspiciousConfigList	array<object>	The list of plugin configuration information.
	object	The plugin configuration information.
Type	string	The name of the plug-in. Valid values: alihips: trojan-specific prevention alisecguard: attack-specific prevention alinet: defense against attacks on servers	alisecguard
Config	boolean	Indicates whether the plug-in is enabled. Valid values: true: yes false: no	true
Msg	string	The message that indicates whether you are authorized to install the plug-in on your server or whether the plug-in is installed on your server. Valid values: authorized: authorized unauthorized: unauthorized unbind: not installed nonsupport: not supported	authorized
OverallConfig	boolean	Indicates whether the plug-in is globally configured. Valid values: true: yes false: no	true
Code	integer	The result code. A value of 200 indicates success. Other values indicate failure. You can use this field to determine the cause of the failure.	200
Message	string	The detailed information of the error code.	successful

Examples

Success response

JSON format

{
  "RequestId": "7E0618A9-D5EF-4220-9471-C42B5E92719F",
  "AegisUuidTargetPluginConfigList": [
    {
      "PluginName": "alisecguard",
      "PluginOnlineInstalled": true,
      "PluginOnlineStatus": true,
      "PluginInstallCode": "k5O5nd",
      "PluginVersion": "00_10",
      "AegisSuspiciousConfigList": [
        {
          "Type": "alisecguard",
          "Config": true,
          "Msg": "authorized",
          "OverallConfig": true
        }
      ]
    }
  ],
  "Code": 200,
  "Message": "successful"
}

Error codes

HTTP status code	Error code	Error message
400	IllegalParam	Illegal param
500	ServerError	ServerError
403	NoPermission	caller has no permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.