Updated on 2025-08-15 GMT+08:00

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

Project ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

ID of the enterprise project that a server belongs.

An enterprise project can be configured only after the enterprise project function is enabled.

Enterprise project ID. The value 0 indicates the default enterprise project. To query servers in all enterprise projects, set this parameter to all_granted_eps. If you have only the permission on an enterprise project, you need to transfer the enterprise project ID to query the server in the enterprise project. Otherwise, an error is reported due to insufficient permission.

host_name

No

String

Server name

host_id

No

String

Server ID

public_ip

No

String

EIP

private_ip

No

String

Private IP address

group_name

No

String

Server group name

os_type

No

String

OS type. Its value can be:

  • linux

  • windows

protect_status

No

String

Quota status. The value can be:

  • opened: WTP quota has been bound.

wtp_status

No

String

WTP status. The value can be:

  • opened: protection summary

  • opening: The protection is being opened.

  • open_failed: The protection fails.

  • partial_protection: partial protection

  • protection_interruption: protection interruption

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.

limit

No

Integer

Default value: 10

offset

No

Integer

Offset, which specifies the start position of the record to be returned.

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 a user token.

region

No

String

Region ID

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

data_list

Array of WtpProtectHostResponseInfo objects

data list

total_num

Integer

total number of WTP protected servers

Table 5 WtpProtectHostResponseInfo

Parameter

Type

Description

host_name

String

Server name

host_id

String

Server ID

public_ip

String

EIP

private_ip

String

Private IP address

ipv6

String

Private IPv6 address

group_name

String

Server group name

asset_value

String

Asset importance. Its value can be:

  • important

  • common

  • test

os_bit

String

OS bit version

os_type

String

OS (Linux or Windows)

protect_status

String

Protection status.

  • opening: The protection is being opened.

  • opened: protection enabled

  • open_failed: The protection fails.

  • partial_protection: partial protection

  • protection_interruption: protection interruption

rasp_protect_status

String

Dynamic WTP status.

  • closed

  • opened

anti_tampering_times

Long

Number of blocked tampering attacks

detect_tampering_times

Long

Number of detected tampering attacks

last_detect_time

Long

Latest detection time (ms)

scheduled_shutdown_status

String

Status of scheduled protection.

  • opened

  • closed

os_name

String

System name

os_version

String

OS version

host_status

String

Server status. Its value can be:

  • ACTIVE

  • SHUTOFF

  • BUILDING

  • ERROR

agent_status

String

Agent status.

  • not_installed: The agent is not installed.

  • online: The agent is online.

  • offline: The agent is offline.

protect_dir_num

Integer

Number of protected directories

remote_backbup_info

WtpRemoteBackupResponseInfo object

Remote backup server information.

Table 6 WtpRemoteBackupResponseInfo

Parameter

Type

Description

backup_addr

String

Remote backup address (IP address + port number)

backup_host_id

String

Remote backup server ID

backup_host_name

String

Remote backup server name

remote_backup

Boolean

Whether to enable remote backup.

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 ID 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

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.

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 ID is XX by default.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
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());
        }
    }
}

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 ID is XX by default.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# 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)

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 ID is XX by default.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
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)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.