Querying the List of Protected Servers

Function

This API is used to query the protected server list. It queries the protected server data, including the server name, IP address, operating system, server group name, protection policy, protection status, microservice protection status, RASP protection status, and number of attacks prevented by RASP.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v5/{project_id}/rasp/servers

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project.
offset	Yes	Integer	Start time of the query.
limit	Yes	Integer	Number of records displayed on each page.
host_name	No	String	Server name
os_type	No	String	OS type. Its value can be: Linux Windows
host_ip	No	String	Server private IP address
app_type	No	String	Application type. The value can be: java: Java application protection.
app_status	Yes	String	Application protection status. The options are as follows: closed: protection disabled opened: protection enabled

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
x-auth-token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_num	Integer	Total
data_list	Array of ProtectionServeInfo objects	list

**Table 5** ProtectionServeInfo
Parameter	Type	Description
host_id	String	Server ID
agent_id	String	Agent ID
agent_version	String	Agent version
host_name	String	Server name
public_ip	String	EIP
private_ip	String	Private IP address.
os_type	String	Definition OS supported by the policy. Constraints N/A Range Its value can be: Windows Linux Default Value N/A
rasp_status	String	Definition Application protection status. Constraints N/A Range The options are as follows: app_install_processing: The protection is being enabled. app_protected: The protection is successful. app_install_failed: Protection failed (installation failed). app_not_configure: not protected app_partially_protected: partially protected app_all_failed: Protection failed. app_uninstall_processing: uninstalling Default Value N/A
policy_name	String	Protection policy name
is_friendly_user	Boolean	Whether the user is a friendly user
agent_support_auto_attach	Boolean	Whether the agent supports dynamic loading
agent_status	String	Definition Agent status. Constraints N/A Range The options are as follows: installed not_installed online offline install_failed installing Default Value N/A
auto_attach	Boolean	Whether the dynamic loading is enabled.
protect_status	String	Protection status \| Agent protection status. It can be: - 0: disabled; - 1: enabled
group_id	String	Server group ID
group_name	String	Server group name
protect_event_num	Long	Number of protection events
rasp_port	Integer	RASP port number

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 9,
  "data_list" : [ {
    "host_id" : "d04e7903-0a66-4fde-93e7-*******",
    "agent_id" : "06af36ee0874501a2***********bb908fb818a8fdf2e0af487457ebc22",
    "agent_version" : "3.2.17",
    "host_name" : "ecs-******-nacos-test",
    "public_ip" : "",
    "private_ip" : "192.168.0.**",
    "os_type" : "Linux",
    "group_id" : "d9327506-5282-3017-9077-******",
    "protect_event_num" : 0,
    "rasp_port" : 19999,
    "auto_attach" : false,
    "rasp_status" : "app_not_configure",
    "protect_status" : "opened",
    "policy_name" : "Default policy",
    "agent_support_auto_attach" : true,
    "is_friendly_user" : true
  } ]
}