Querying the WTP list

Function

This API is used to query the servers protected by web tamper protection (WTP).

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	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 can contain 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.
host_name	No	String	Definition Server name. Constraints N/A Range The value contains 1 to 256 characters. Default Value N/A
host_id	No	String	Definition Server ID. Constraints N/A Range The value can contain 1 to 64 characters. Default Value N/A
public_ip	No	String	Server public IP address
private_ip	No	String	Definition Server private IP address. Constraints N/A Range The value can contain 1 to 128 characters. Default Value N/A
group_name	No	String	Server group name
os_type	No	String	OS type. Its value can be: Linux Windows
asset_value	No	String	Asset importance. The options are as follows: important common test
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	Parameter description: Number of records displayed on each page. Constraints: N/A Options: Value range: 10-200 Default value: 10
protect_status	No	String	Definition Web tamper protection status. Constraints N/A Range opened: Web tamper protection is enabled. Default Value N/A
wtp_status	No	String	Definition Specific web tamper protection status. Constraints N/A Range opened: The protection is in progress. opening: The function is being enabled. open_failed: Protection failed. partial_protection: Partially protected. protection_interruption: Protection interrupted. Default Value N/A
agent_status	No	String	Definition Agent status. Constraints N/A Range not_installed: The agent is not installed. online: The agent is online. offline: The agent is offline. Default Value N/A
rasp_status	No	String	Definition Dynamic WTP status. Constraints N/A Range opened: Dynamic WTP is enabled. closed: Dynamic WTP is not enabled. 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
region	No	String	Definition Region ID, which is used to query assets in the required region. For details about how to obtain a region ID, see Obtaining a Region ID. Constraints N/A Range The value can contain 1 to 128 characters. Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
data_list	Array of WtpProtectHostResponseInfo objects	Definition Web tamper protection list information. Range Minimum value: 0; maximum value: 200
total_num	Integer	Definition Total number. Range The value range is 0 to 2,147,483,647.

**Table 5** WtpProtectHostResponseInfo
Parameter	Type	Description
host_name	String	Definition Server name. Range The value can contain 1 to 256 characters.
host_id	String	Definition Host ID. Range Length: 1 to 64 characters
public_ip	String	Definition EIP. Range The value can contain 1 to 256 characters.
private_ip	String	Definition Server private IP address. Range The value can contain 1 to 128 characters.
group_id	String	Definition Policy group ID. Range Length: 36 to 64 characters
group_name	String	Definition Server group name. Range The value can contain 0 to 256 characters.
asset_value	String	Asset importance. Its value can be: important common test
os_bit	String	Definition OS bit version. Range The value can contain 1 to 64 characters.
os_type	String	Definition OS type. Range Linux Windows
protect_status	String	Definition WTP status. Range opening: The function is being enabled. opened: The protection is in progress. closed: not protected open_failed: Protection failed. partial_protection: Partially protected. protection_interruption: Protection interrupted. protection_pause: Protection paused.
charging_mode	String	Definition Billing mode. Range packet_cycle: yearly/monthly on_demand: pay-per-use
resource_id	String	Definition Resource ID. Range Length: 0 to 128 characters
rasp_protect_status	String	Definition Dynamic WTP status. Range opened: Dynamic WTP is enabled. closed: Dynamic WTP is not enabled.
anti_tampering_times	Long	Definition Number of attacks blocked by static WTP in the last seven days. Range Minimum value: 0; maximum value: 2000000000
detect_tampering_times	Long	Definition Number of attacks blocked by dynamic WTP in the last seven days. Range Minimum value: 0; maximum value: 2000000000
os_name	String	Definition OS name. Range Length: 0 to 128 characters
os_version	String	Definition OS version. Range Length: 0 to 256 characters
host_status	String	Definition Server status. Constraints N/A Range ACTIVE SHUTOFF BUILDING ERROR
agent_status	String	Definition Agent status. Range not_installed online offline
protect_dir_num	Integer	Definition Number of protected directories. Range Minimum value: 0; maximum value: 50
abnormal_dir_list	Array of strings	Definition Protected directories whose protection status is "Protection failed". This parameter is returned only if there are protected directories with such status. Range 0 to 50 items
abnormal_reason	Integer	Definition Protection failure cause. This parameter is returned only when there are protected directories whose protection status is "Protection failed". Range 1: The path of a protected directory does not exist. 2: The paths of multiple protected directories do not exist. 7: A protected directory is not protected. 8: Multiple protected directories are not protected. 10: A protected directory is a network file system. 11: Multiple protected directories are network file systems.
backup_host_id	String	Definition ID of the remote backup server. This parameter is returned only if the remote backup function is enabled on a Linux server. Range Length: 0 to 64 characters
interrupt_reason	String	Definition Protection interruption cause. This parameter is returned only if the protection status is "Protection interrupted". Range Length: 0 to 256 characters

Example Requests

Query the servers protected by WTP.

GET https://{endpoint}/v5/{project_id}/webtamper/hosts

{
  "protect_status" : "opened",
  "limit" : 10,
  "offset" : 0
}

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 1,
  "data_list" : [ {
    "host_name" : "test",
    "host_id" : "000411f9-42a7-4acd-80e6-f7b9d3db895f",
    "public_ip" : "192.168.0.71",
    "private_ip" : "192.168.0.70,fe80::f816:3eff:fed4:c4d7",
    "ipv6" : "fe80::f816:3eff:fed4:c4d7",
    "asset_value" : "important",
    "group_name" : "testGroup",
    "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,
    "os_name" : "EulerOS",
    "os_version" : 2.3,
    "host_status" : "ACTIVE",
    "agent_status" : "online",
    "protect_dir_num" : 10,
    "remote_backbup_info" : {
      "backup_host_id" : "192.168.0.70",
      "backup_addr" : "/test",
      "backup_host_name" : "name",
      "remote_backup" : true
    }
  } ]
}

SDK Sample Code

The SDK sample code is as follows.

Query the servers protected by WTP.

      
       
         
         
           package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.hss.v5.region.HssRegion;
import com.huaweicloud.sdk.hss.v5.*;
import com.huaweicloud.sdk.hss.v5.model.*;


public class ListWtpProtectHostSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        HssClient client = HssClient.newBuilder()
                .withCredential(auth)
                .withRegion(HssRegion.valueOf("<YOUR REGION>"))
                .build();
        ListWtpProtectHostRequest request = new ListWtpProtectHostRequest();
        try {
            ListWtpProtectHostResponse response = client.listWtpProtectHost(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

          

        

      
     

Query the servers protected by WTP.

      
       
         
         
           # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkhss.v5.region.hss_region import HssRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkhss.v5 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = HssClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(HssRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListWtpProtectHostRequest()
        response = client.list_wtp_protect_host(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

          

        

      
     

Query the servers protected by WTP.

      
       
         
         
           package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    hss "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := hss.NewHssClient(
        hss.HssClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListWtpProtectHostRequest{}
	response, err := client.ListWtpProtectHost(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

          

        

      
     