Help Center/ Host Security Service/ API Reference/ API Description/ Web Tamper Protection/ Exporting the Server List of Web Tamper Protection
Updated on 2025-08-15 GMT+08:00

Exporting the Server List of Web Tamper Protection

Function

This API is used to export the server list of web tamper protection.

Calling Method

For details, see Calling APIs.

URI

POST /v5/{project_id}/webtamper/host/export

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.

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

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

host_id

No

String

Definition

Server ID.

Range

The value can contain 1 to 64 characters.

host_id_list

No

Array of strings

Host ID array.

host_name

No

String

Definition

Server name.

Range

The value can contain 1 to 256 characters.

public_ip

No

String

Definition

EIP.

Range

The value can contain 1 to 256 characters.

private_ip

No

String

Definition

Server private IP address.

Range

The value can contain 1 to 128 characters.

agent_id

No

String

Definition

Agent ID

Constraints

N/A

Range

The value can contain 1 to 64 characters.

Default Value

N/A

os_type

No

String

Definition

OS type.

Range

  • Linux

  • Windows

asset_value

No

String

Asset importance. Its value can be:

  • important

  • common

  • test

group_name

No

String

Definition

Server group name.

Range

The value can contain 0 to 256 characters.

protect_status

No

String

Protection status. It can be:

  • closed

  • opened

agent_status

No

String

Agent status. It can be:

  • installed

  • not_installed

  • online

  • offline

  • install_failed

  • installing

  • not_online: All status except online. This value is used only as a query condition.

rasp_protect_status

No

String

Dynamic Web Tamper Protection Status

  • opened

  • closed

wtp_status

No

String

Protection status.

  • closed: not protected

  • opened: protection enabled

  • open_failed: The protection fails.

  • opening: The protection is being opened.

  • partial_protection: partial protection

offset

No

Integer

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

limit

No

Integer

Number of records displayed on each page.

export_size

No

Integer

Number of exported data records.

export_headers

No

Array<Array<String>>

Export table header set

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

task_id

String

Export task ID

Example Requests

"export_headers: - - host_name - Server name - - host_id - Server ID - - public_ip - Public network IP - - private_ip - Private network IP - - agent_status - Agent status - - protect_status - Protection status - - protect_dir_num - Number of protected directories - - rasp_protect_status - Dynamic anti-tamper status - - anti_tampering_times - Static anti-tamper attack (last seven days) - - detect_tampering_times - Dynamic anti-tamper attack (last seven days) - - protect_dir - Protected directory - - exclude_child_dir - Excluded subdirectory - - exclude_file_list - Excluded file path list - - local_backup_dir - Local backup path - - exclude_file_type - Excluded file type - - dir_protect_status - Protection status - - error - Error information"

Example Responses

Status code: 200

Request succeeded.

{
  "task_id" : "9e8***4-d26b-426d-a2be-765930242984"
}

SDK Sample Code

The SDK sample code is as follows.

 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
48
49
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 ExportWebTamperHostSolution {

    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();
        ExportWebTamperHostRequest request = new ExportWebTamperHostRequest();
        ExportWebTamperHostRequestInfo body = new ExportWebTamperHostRequestInfo();
        request.withBody(body);
        try {
            ExportWebTamperHostResponse response = client.exportWebTamperHost(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());
        }
    }
}
 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
# 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 = ExportWebTamperHostRequest()
        request.body = ExportWebTamperHostRequestInfo(
        )
        response = client.export_web_tamper_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)
 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
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.ExportWebTamperHostRequest{}
	request.Body = &model.ExportWebTamperHostRequestInfo{
	}
	response, err := client.ExportWebTamperHost(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.