Querying Web Tamper Protection Event List

Function

This API is used to query the web tamper protection event list.

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}/webtamper/events

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value contains 1 to 256 characters. Default Value N/A

**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.
type	Yes	String	Definition Web tamper protection type. Constraints N/A Range container_wtp: container WTP Default Value N/A
offset	No	Integer	Definition Offset, which specifies the start position of the record to be returned. Constraints N/A Range The value range is 0 to 2,000,000. Default Value The default value is 0.
limit	No	Integer	Definition Number of records displayed on each page. Constraints N/A Range Value range: 10 to 200 Default Value 10
image_name	No	String	Definition Image Constraints N/A Range The value can contain 1 to 512 characters. Default Value N/A
image_version	No	String	Definition Image version Constraints N/A Range The value can contain 1 to 128 characters. Default Value N/A
host_name	No	String	Definition Server Name Constraints N/A Range The value can contain 0 to 128 characters. Default Value N/A
host_id	No	String	Definition Server ID. Constraints N/A Range The value can contain 0 to 128 characters. Default Value N/A
host_private_ip	No	String	Definition Server private IP address Constraints N/A Range The value can contain 0 to 128 characters. Default Value N/A
container_name	No	String	Definition Container name. Constraints N/A Range The value can contain 0 to 128 characters. Default Value N/A
container_id	No	String	Definition Affected container ID Constraints N/A Range The value can contain 0 to 256 characters. Default Value N/A
cluster_name	No	String	Definition Cluster name. Constraints N/A Range The value can contain 0 to 256 characters. Default Value N/A
cluster_id	No	String	Definition Cluster ID. Constraints N/A Range The value can contain 1 to 128 characters. Default Value N/A
file_path	No	String	Definition Path of the protected file. Constraints N/A Range The value can contain 0 to 256 characters. Default Value N/A
process_path	No	String	Definition Process path. Constraints N/A Range The value can contain 0 to 256 characters. Default Value N/A
process_env	No	String	Definition Process environment, which refers to the process in a container or on a host. Constraints N/A Range host: host process container: container process Default Value N/A
web_app_name	No	String	Definition Web Application Name Constraints N/A Range The value can contain 0 to 128 characters. Default Value N/A
start_event_time	No	Long	Definition Start time, which is a 13-digit timestamp. Constraints N/A Range The value range is 0 to 9,223,372,036,854,775,807. Default Value N/A
end_event_time	No	Long	Definition Start time, which is a 13-digit timestamp. Constraints N/A Range The value range is 0 to 9,223,372,036,854,775,807. Default Value N/A

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_num	Integer	Definition Total number of web tamper protection events. Range The value range is 0 to 2,147,483,647.
data_list	Array of WebTamperEventResponseInfo objects	Definition Web tamper protection event list. Range The value can contain 0 to 200 WebTamperEventResponseInfo objects.

**Table 5** WebTamperEventResponseInfo
Parameter	Type	Description
file_path	String	Definition Protected File Range The value can contain 0 to 256 characters.
event_description	String	Definition Event description. Range The value can contain 0 to 512 characters.
process_path	String	Definition Process path. Range The value can contain 0 to 256 characters.
process_cmd	String	Definition Process command line Range The value can contain 0 to 256 characters.
process_pid	Integer	Definition PID of the process Range The value range is 0 to 2,147,483,647.
process_env	String	Definition Process environment, which refers to the process in a container or on a host. Range The value can contain 0 to 32 characters.
web_app_name	String	Definition Web Application Name Range The value can contain 0 to 128 characters.
event_time	Long	Definition Detection time (ms) Range The value range is 0 to 9,223,372,036,854,775,807.
host_info	WebTamperEventHostInfo object	Definition Server information corresponding to the web tamper protection event. Range N/A
container_info	WebTamperEventContainerInfo object	Definition Container information corresponding to the web tamper protection event. Range N/A

**Table 6** WebTamperEventHostInfo
Parameter	Type	Description
host_id	String	Definition Host ID. Range The value can contain 1 to 128 characters.
host_name	String	Definition Host Name Range The value can contain 1 to 256 characters.
public_ip	String	Definition Server EIP. Range The value can contain 1 to 128 characters.
private_ip	String	Definition Private IP address of the server. Range The value can contain 1 to 128 characters.
asset_value	String	Definition Server asset importance. Range important common test
os_type	String	Definition OS Type Range The options are as follows: Linux Windows
os_name	String	Definition System Name Range The value can contain 0 to 128 characters.
host_status	String	Definition Server Status Range The options are as follows: ACTIVE: running SHUTOFF: shut down BUILDING: creating ERROR: faulty
agent_status	String	Definition Agent Status Range The options are as follows: installed not_installed online offline install_failed installing

**Table 7** WebTamperEventContainerInfo
Parameter	Type	Description
image_name	String	Definition Image Range The value can contain 1 to 256 characters.
image_version	String	Definition Image version Range The value can contain 1 to 256 characters.
container_id	String	Definition Container ID Range The value can contain 1 to 256 characters.
container_name	String	Definition Container name. Range The value can contain 1 to 256 characters.
pod_name	String	Definition Pod name. Range The value can contain 1 to 256 characters.
pod_ip	String	Definition Pod IP address. Range The value can contain 1 to 256 characters.
namespace	String	Definition Namespace. Range The value can contain 1 to 256 characters.
cluster_id	String	Definition Cluster ID. Range The value can contain 1 to 128 characters.
cluster_name	String	Definition Cluster name. Range The value can contain 1 to 256 characters.

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 1,
  "data_list" : [ {
    "file_path" : "",
    "event_description" : "",
    "process_path" : "",
    "process_cmd" : "",
    "process_pid" : 12121,
    "event_time" : 1760946685,
    "host_info" : {
      "host_name" : "",
      "host_id" : "",
      "private_ip" : "",
      "public_ip" : "",
      "asset_value" : "",
      "os_type" : "",
      "os_name" : "",
      "agent_status" : "",
      "host_status" : ""
    },
    "container_info" : {
      "image_name" : "",
      "image_version" : "",
      "container_name" : "",
      "container_id" : "",
      "pod_name" : "",
      "pod_ip" : "",
      "namespace" : "",
      "cluster_name" : "",
      "cluster_id" : ""
    }
  } ]
}