Querying the Protection List

Function

This API is used to query the protection list.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/webtamper/hosts

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	User ID Minimum: 0 Maximum: 64

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Enterprise project Minimum: 0 Maximum: 64
host_name	No	String	Server name Minimum: 0 Maximum: 256
host_id	No	String	Cloud server ID Minimum: 0 Maximum: 128
public_ip	No	String	EIP Minimum: 0 Maximum: 128
private_ip	No	String	Private IP address Minimum: 0 Maximum: 128
group_name	No	String	Server group name Minimum: 0 Maximum: 256
os_type	No	String	OS type. Its value can be: linux windows Minimum: 0 Maximum: 32
protect_status	No	String	Protection status. closed: disabled opened: protection enabled Minimum: 0 Maximum: 32
agent_status	No	String	Agent status. Its value can be: not_installed: The agent is not installed. online: The agent is online. offline: The agent is offline. Minimum: 0 Maximum: 32
limit	No	Integer	Default value: 10 Minimum: 10 Maximum: 100 Default: 10
offset	No	Integer	Default value: 0 Minimum: 0 Maximum: 100 Default: 0

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	IAM token Minimum: 1 Maximum: 32768
region	Yes	String	Region Id Minimum: 0 Maximum: 32

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
data_list	Array of WtpProtectHostResponseInfo objects	data list Array Length: 0 - 200000
total_num	Integer	total number Minimum: 0 Maximum: 65535

**Table 5** WtpProtectHostResponseInfo
Parameter	Type	Description
host_name	String	Server name Minimum: 0 Maximum: 256
host_id	String	Cloud server ID Minimum: 0 Maximum: 128
public_ip	String	EIP Minimum: 0 Maximum: 128
private_ip	String	Private IP address Minimum: 0 Maximum: 128
group_name	String	Server group name Minimum: 0 Maximum: 256
os_bit	String	OS bit version Minimum: 0 Maximum: 8
os_type	String	OS (linux or windows) Minimum: 0 Maximum: 32
protect_status	String	Protection status. Its value can be: closed opened Minimum: 0 Maximum: 32
rasp_protect_status	String	Dynamic WTP status. closed opened Minimum: 0 Maximum: 32
anti_tampering_times	Long	Number of blocked tampering attacks Minimum: 0 Maximum: 2000000000
detect_tampering_times	Long	Number of detected tampering attacks Minimum: 0 Maximum: 2000000000
last_detect_time	Long	Last scan time Minimum: 0 Maximum: 4070880000000
scheduled_shutdown_status	String	Status of scheduled protection. opened closed Minimum: 0 Maximum: 32
agent_status	String	Agent status. not_installed: The agent is not installed. online: The agent is online. offline: The agent is offline. Minimum: 0 Maximum: 32

Example Requests

This API is used to query the 10 records on the first page of WTP status list of servers whose status is enabled and enterprise project is XX by default.

GET https://{endpoint}/v5/{project_id}/webtamper/hosts?offset=XX&limit=XX&protect_status=opened&enterprise_project_id=XX

{
  "protect_status" : "opened"
}

Example Responses

Status code: 200

{
  "total_num" : 1,
  "data_list" : [ {
    "host_name" : "test",
    "host_id" : "000411f9-42a7-4acd-80e6-f7b9d3db895f",
    "public_ip" : "",
    "private_ip" : "192.168.0.70",
    "group_name" : "UNINSTALL",
    "os_bit" : "64",
    "os_type" : "Linux",
    "protect_status" : "opened",
    "rasp_protect_status" : "opened",
    "anti_tampering_times" : 0,
    "detect_tampering_times" : 0,
    "last_detect_time" : 0,
    "agent_status" : "not_installed"
  } ]
}