Help Center/ Host Security Service/ API Reference/ API Description/ Web Tamper Protection/ Querying the Status of Static WTP for a Server
Updated on 2024-01-31 GMT+08:00

Querying the Status of Static WTP for a Server

Function

This API is used to query the status of static WTP for a server.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/webtamper/static/protect-history

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_id

Yes

String

Host Id

Minimum: 0

Maximum: 128

start_time

Yes

Long

Start time

Minimum: 0

Maximum: 4070880000000

end_time

Yes

Long

End time

Minimum: 0

Maximum: 4070880000000

limit

Yes

Integer

limit

Minimum: 0

Maximum: 100

offset

Yes

Integer

offset

Minimum: 0

Maximum: 100

host_name

No

String

Server name

Minimum: 0

Maximum: 128

host_ip

No

String

Server IP address

Minimum: 0

Maximum: 128

file_path

No

String

Protected file

Minimum: 0

Maximum: 128

file_operation

No

String

Types of file operations, including:

  • add

  • delete

  • modify

  • attribute

Minimum: 0

Maximum: 128

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

host_name

String

Server name

Minimum: 0

Maximum: 256

protect_status

String

Protection status. Its value can be:

  • close

  • opened

Minimum: 0

Maximum: 32

total_num

Long

total number

Minimum: 0

Maximum: 20000000

data_list

Array of HostProtectHistoryResponseInfo objects

data list

Array Length: 0 - 20000

Table 5 HostProtectHistoryResponseInfo

Parameter

Type

Description

occr_time

Long

Detection time

Minimum: 0

Maximum: 4070880000000

file_path

String

Tampered file path

Minimum: 0

Maximum: 2000

file_operation

String

Types of file operations

  • add

  • delete

  • modify

  • attribute

  • unknown

Minimum: 0

Maximum: 32

host_name

String

Server name

Minimum: 0

Maximum: 64

host_ip

String

Server IP address

Minimum: 0

Maximum: 64

process_id

String

Process ID

Minimum: 0

Maximum: 8

process_name

String

Process name

Minimum: 0

Maximum: 200

process_cmd

String

Process command line

Minimum: 0

Maximum: 8191

Example Requests

Query the static WTP status of a server where target ID is caa958ad-a481-4d46-b51e-6861b8864515, start time is 1668563099000, and end time is 1668563199000.

GET https://{endpoint}/v5/{project_id}/webtamper/static/protect-history

{
  "host_id" : "caa958ad-a481-4d46-b51e-6861b8864515",
  "start_time" : 1668563099000,
  "end_time" : 1668563199000,
  "limit" : 10,
  "offset" : 0
}

Example Responses

Status code: 200

successful response

{
  "host_name" : "ecs-ubuntu",
  "protect_status" : "opened",
  "total_num" : 1,
  "data_list" : [ {
    "occr_time" : 1668156691000,
    "file_path" : "/root/test/tamper/test.xml",
    "host_name" : "hss-test",
    "host_ip" : "192.168.5.98",
    "file_operation" : "add",
    "process_id" : "18672",
    "process_name" : "program1",
    "process_cmd" : "del test.xml"
  } ]
}

Status Codes

Status Code

Description

200

successful response

Error Codes

See Error Codes.