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

查询网页防篡改防护列表

功能介绍

查询网页防篡改防护列表

调用方法

请参见如何调用API

URI

GET /v5/{project_id}/webtamper/hosts

表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)。

host_name

String

参数解释:

服务器名称

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

host_id

String

参数解释:

服务器ID

约束限制:

不涉及

取值范围:

字符长度1-64位

默认取值:

不涉及

public_ip

String

服务器公网IP

private_ip

String

参数解释:

服务器私有IP

约束限制:

不涉及

取值范围:

字符长度1-128位

默认取值:

不涉及

group_name

String

服务器组名称

os_type

String

操作系统类型,包含如下2种。

  • Linux:Linux。

  • Windows:Windows。

asset_value

String

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

  • important :重要资产

  • common :一般资产

  • test :测试资产

offset

Integer

参数解释:

偏移量:指定返回记录的开始位置

约束限制:

不涉及

取值范围:

最小值0,最大值2000000

默认取值:

默认为0

limit

Integer

参数解释:

每页显示个数

约束限制:

不涉及

取值范围:

取值10-200

默认取值:

10

protect_status

String

参数解释:

网页防篡改防护开启状态

约束限制:

不涉及

取值范围:

  • opened :已开启网页防篡改防护。

默认取值:

不涉及

wtp_status

String

参数解释:

网页防篡改详细防护状态

约束限制:

不涉及

取值范围:

  • opened : 防护中。

  • opening : 开启中。

  • open_failed : 防护失败。

  • partial_protection : 部分防护。

  • protection_interruption : 防护中断。

默认取值:

不涉及

agent_status

String

参数解释:

Agent状态

约束限制:

不涉及

取值范围:

  • not_installed : agent未安装。

  • online : agent在线。

  • offline : agent不在线。

默认取值:

不涉及

rasp_status

String

参数解释:

动态网页防篡改防护开启状态

约束限制:

不涉及

取值范围:

  • opened :已开启动态网页防篡改防护。

  • closed :未开启动态网页防篡改防护。

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

region

String

参数解释:

区域ID,用于查询目的区域内的资产。获取方式请参见获取区域ID

约束限制:

不涉及

取值范围:

字符长度1-128位

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

data_list

Array of WtpProtectHostResponseInfo objects

参数解释:

网页防篡改防护列表信息

取值范围:

最小值0,最大值200

total_num

Integer

参数解释:

总数

取值范围:

最小值0,最大值2147483647

表5 WtpProtectHostResponseInfo

参数

参数类型

描述

host_name

String

参数解释:

服务器名称

取值范围:

字符长度1-256位

host_id

String

参数解释

主机ID

取值范围

字符长度1-64位

public_ip

String

参数解释

弹性公网IP地址

取值范围

字符长度1-256位

private_ip

String

参数解释

服务器私有IP

取值范围

字符长度1-128位

group_id

String

参数解释

策略组ID

取值范围

字符长度36-64位

group_name

String

参数解释:

服务器组名称

取值范围:

字符长度0-256位

asset_value

String

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

  • important :重要资产

  • common :一般资产

  • test :测试资产

os_bit

String

参数解释

操作系统位数

取值范围

字符长度1-64位

os_type

String

参数解释

操作系统类型

取值范围

  • Linux:Linux。

  • Windows:Windows。

protect_status

String

参数解释:

网页防篡改防护状态

取值范围:

  • opening : 开启中。

  • opened : 防护中。

  • closed : 未防护。

  • open_failed : 防护失败。

  • partial_protection : 部分防护。

  • protection_interruption : 防护中断。

  • protection_pause : 防护暂停。

charging_mode

String

参数解释

计费模式

取值范围

  • packet_cycle :包年/包月。

  • on_demand :按需计费。

resource_id

String

参数解释

资源ID

取值范围

字符长度0-128位

rasp_protect_status

String

参数解释:

动态网页防篡改防护开启状态

取值范围:

  • opened :已开启动态网页防篡改防护。

  • closed :未开启动态网页防篡改防护。

anti_tampering_times

Long

参数解释:

近7天静态网页防篡改攻击次数

取值范围:

最小值0,最大值2000000000

detect_tampering_times

Long

参数解释:

近7天动态网页防篡改攻击次数

取值范围:

最小值0,最大值2000000000

os_name

String

参数解释

操作系统名称

取值范围

字符长度0-128位

os_version

String

参数解释

操作系统版本

取值范围

字符长度0-256位

host_status

String

参数解释:

服务器状态

取值范围:

  • ACTIVE :运行中。

  • SHUTOFF :关机。

  • BUILDING :创建中。

  • ERROR :故障。

agent_status

String

参数解释:

Agent状态

取值范围:

  • not_installed:未安装。

  • online:在线。

  • offline:离线。

protect_dir_num

Integer

参数解释:

防护目录数

取值范围:

最小值0,最大值50

abnormal_dir_list

Array of strings

参数解释:

防护状态是防护失败的防护目录列表,仅当存在防护状态是防护失败的防护目录时返回。

取值范围:

最少0条,最多50条

abnormal_reason

Integer

参数解释:

防护失败原因,仅当存在防护状态是防护失败的防护目录时返回。

取值范围:

  • 1 :某一个防护目录的路径不存在。

  • 2 :多个防护目录的路径不存在。

  • 7 :某一个防护目录未防护。

  • 8 :多个防护目录未防护。

  • 10 :某一个防护目录是网络文件系统。

  • 11 :多个防护目录是网络文件系统。

backup_host_id

String

参数解释

远端备份服务器ID,仅当Linux服务器开启远端备份功能时返回。

取值范围

字符长度0-64位

interrupt_reason

String

参数解释

防护中断原因,仅当防护状态是防护中断时返回。

取值范围

字符长度0-256位

请求示例

查询网页防篡改防护列表

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

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

响应示例

状态码:200

请求已成功

{
  "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代码示例

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
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());
        }
    }
}

查询网页防篡改防护列表

 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)

查询网页防篡改防护列表

 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)
    }
}

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

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档