文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 网页防篡改/ 导出网页防篡改防护目录列表
更新时间:2025-09-26 GMT+08:00
分享

导出网页防篡改防护目录列表

功能介绍

导出网页防篡改防护目录列表

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID

如需查询所有企业项目下的资产请传参“all_granted_eps”。

约束限制:

开通企业项目功能后才需要配置企业项目ID参数。

取值范围:

字符长度1-256位

默认取值:

0,表示默认企业项目(default)。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

表4 请求Body参数

参数

是否必选

参数类型

描述

host_id

String

参数解释

主机ID

取值范围

字符长度1-64位

host_id_list

Array of strings

参数解释:

服务器ID列表

取值范围:

不涉及

host_name

String

参数解释:

服务器名称

取值范围:

字符长度1-256位

public_ip

String

参数解释

弹性公网IP地址

取值范围

字符长度1-256位

private_ip

String

参数解释

服务器私有IP

取值范围

字符长度1-128位

agent_id

String

参数解释:

Agent ID。(已废弃,请使用host_id)

约束限制:

不涉及

取值范围:

字符长度1-64位

默认取值:

不涉及

os_type

String

参数解释

操作系统类型

取值范围

  • Linux:Linux。

  • Windows:Windows。

asset_value

String

资产重要性,包含如下3种

  • important :重要资产

  • common :一般资产

  • test :测试资产

group_name

String

参数解释:

服务器组名称

取值范围:

字符长度0-256位

protect_status

String

防护状态。(已废弃,请使用wtp_status)

agent_status

String

参数解释:

Agent状态。

约束限制:

不涉及

取值范围:

  • not_installed:未安装。

  • online:在线。

  • offline:离线。

默认取值:

不涉及。

rasp_protect_status

String

动态网页防篡改防护状态

  • opened : 防护中

  • closed : 未防护

wtp_status

String

参数解释:

网页防篡改防护状态

取值范围:

  • opening : 开启中。

  • opened : 防护中。

  • open_failed : 防护失败。

  • partial_protection : 部分防护。

  • protection_interruption : 防护中断。

offset

Integer

偏移量。(已废弃,请使用export_size)

limit

Integer

每页显示个数。(已废弃,请使用export_size)

export_headers

Array<Array<String>>

参数解释:

导出数据表头信息详情

约束限制:

表头信息应为如下格式[[字段1,表头1显示名称],[字段2,表头2显示名称],[字段3,表头3显示名称]]

取值范围:

可从如下取值中选取部分或全部组成表头信息

  • host_name:服务器名称。

  • host_id:服务器ID。

  • public_ip:弹性公网IP地址。

  • private_ip:私有IP地址。

  • charging_mode:计费模式。

  • agent_status:Agent状态。

  • protect_status:防护状态。

  • protect_dir_num:防护目录数。

  • rasp_protect_status:动态防篡改状态。

  • anti_tampering_times:静态防篡改攻击(近七天)。

  • detect_tampering_times:动态防篡改攻击(近七天)。

  • protect_dir:防护目录。

  • exclude_child_dir:排除子目录。

  • exclude_file_list:排除文件路径列表。

  • local_backup_dir:本地备份路径。

  • exclude_file_type:排除文件类型。

  • dir_protect_status:防护目录状态。

  • error:错误信息。

默认取值:

不涉及

export_size

Integer

参数解释:

导出数据条数上限

约束限制:

不涉及

取值范围:

最小值1,最大值200000

默认取值:

不涉及

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

task_id

String

参数解释

导出任务的ID

取值范围

字符长度0-128位

请求示例

导出网页防篡改防护目录列表。

POST https://{endpoint}/v5/{project_id}/webtamper/host/export

{
  "export_size" : 10,
  "export_headers" : [ [ "host_name", "服务器名称" ], [ "host_id", "服务器ID" ] ]
}

响应示例

状态码:200

请求已成功

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

SDK代码示例

SDK代码示例如下。

导出网页防篡改防护目录列表。

 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
50
51
52
53
54
55
56
57
58
59
60
61
62
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.*;

import java.util.List;
import java.util.ArrayList;

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();
        List<String> listExportHeadersExportHeaders = new ArrayList<>();
        listExportHeadersExportHeaders.add("host_id");
        listExportHeadersExportHeaders.add("服务器ID");
        List<String> listExportHeadersExportHeaders1 = new ArrayList<>();
        listExportHeadersExportHeaders1.add("host_name");
        listExportHeadersExportHeaders1.add("服务器名称");
        List<List<String>> listbodyExportHeaders = new ArrayList<>();
        listbodyExportHeaders.add(listExportHeadersExportHeaders);
        listbodyExportHeaders.add(listExportHeadersExportHeaders1);
        body.withExportSize(10);
        body.withExportHeaders(listbodyExportHeaders);
        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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
# 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()
        listExportHeadersExportHeaders = [
            "host_id",
            "服务器ID"
        ]
        listExportHeadersExportHeaders1 = [
            "host_name",
            "服务器名称"
        ]
        listExportHeadersbody = [
            listExportHeadersExportHeaders,
            listExportHeadersExportHeaders1
        ]
        request.body = ExportWebTamperHostRequestInfo(
            export_size=10,
            export_headers=listExportHeadersbody
        )
        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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
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{}
	var listExportHeadersExportHeaders = []string{
        "host_id",
	    "服务器ID",
    }
	var listExportHeadersExportHeaders1 = []string{
        "host_name",
	    "服务器名称",
    }
	var listExportHeadersbody = [][]string{
        listExportHeadersExportHeaders,
        listExportHeadersExportHeaders1,
    }
	request.Body = &model.ExportWebTamperHostRequestInfo{
		ExportSize: int32(10),
		ExportHeaders: listExportHeadersbody,
	}
	response, err := client.ExportWebTamperHost(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档