文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 网页防篡改/ 查看网页防篡改策略信息
更新时间:2025-09-08 GMT+08:00

查看网页防篡改策略信息

功能介绍

查看网页防篡改策略信息

调用方法

请参见如何调用API

URI

GET /v5/{project_id}/webtamper/{host_id}/policy

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

host_id

String

参数解释:

服务器ID,要求服务器已开启网页防篡改防护,或关闭防护但未删除网页防篡改策略

约束限制:

需要使用 ListWtpProtectHost 接口查询网页防篡改主机防护状态列表信息,在 ListWtpProtectHost 接口的响应体中存在的host_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位

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

protect_dir_num

Integer

参数解释:

防护目录数

取值范围:

取值0-50

protect_dir_info

WtpProtectDirResponseInfo object

防护目录信息

enable_timing_off

Boolean

参数解释:

定时开关状态

取值范围:

  • True :开启定时关闭防护功能。

  • False :未开启定时关闭防护功能。

timing_off_config_info

ListTimingOffConfigInfoResponseInfo object

定时关闭防护功能配置详情

enable_rasp_protect

Boolean

参数解释:

动态网页防篡改开启状态

取值范围:

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

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

rasp_path

String

参数解释:

动态网页防篡改的Tomcat bin目录

取值范围:

字符长度0-512位

enable_privileged_process

Boolean

参数解释:

特权进程开启状态

取值范围:

  • True :开启特权进程。

  • False :未开启特权进程。

privileged_child_status

Boolean

参数解释:

特权进程子进程可信状态,需先开启特权进程

取值范围:

  • True :开启特权进程子进程可信。

  • False :未开启特权进程子进程可信。

privileged_process_path_list

Array of strings

参数解释:

特权进程文件路径列表

取值范围:

最少0条,最多10条

privileged_process_info

ListPrivilegedProcessResponseInfo object

特权进程配置详情

表5 WtpProtectDirResponseInfo

参数

参数类型

描述

protect_dir_list

Array of WtpProtectHostDirResponseInfo objects

参数解释:

防护目录列表

取值范围:

最少0条,最多50条

exclue_file_type

String

排除文件类型

exclude_file_type

String

参数解释:

排除文件类型

取值范围:

字符长度0-512位

protect_mode

String

参数解释:

防护模式

取值范围:

  • recovery :拦截模式。

  • alarm :告警模式。

表6 WtpProtectHostDirResponseInfo

参数

参数类型

描述

protect_dir

String

参数解释:

防护目录

取值范围:

字符长度0-512位

exclude_child_dir

String

参数解释:

排除子目录

取值范围:

字符长度0-512位

exclude_file_path

String

参数解释:

排除文件路径

取值范围:

字符长度0-512位

exclue_file_path

String

排除文件路径

local_backup_dir

String

参数解释:

本地备份路径

取值范围:

字符长度0-512位

protect_status

String

参数解释:

防护状态

取值范围:

  • closed :未开启。

  • opened :防护中。

  • opening :开启中。

  • closing :关闭中。

  • open_failed :防护失败。

error

String

参数解释:

失败原因,当防护状态为open_failed时存在失败原因

取值范围:

字符长度0-512位

表7 ListTimingOffConfigInfoResponseInfo

参数

参数类型

描述

week_off_list

Array of integers

参数解释:

自动关闭防护周期列表

取值范围:

最少0条,最多7条

timing_range_list

Array of TimingRangeConfigInfo objects

参数解释:

自动关闭防护时间段

取值范围:

最少0条,最多5条

total_num

Integer

参数解释:

总数

取值范围:

最小值0,最大值2147483647

表8 TimingRangeConfigInfo

参数

参数类型

描述

time_range

String

参数解释:

自动关闭防护的时间段范围

取值范围:

字符长度0-512位

description

String

参数解释:

自动关闭防护的时间段描述

取值范围:

字符长度0-512位

表9 ListPrivilegedProcessResponseInfo

参数

参数类型

描述

data_list

Array of PrivilegedProcessResponseInfo objects

data list

total_num

Integer

total number

表10 PrivilegedProcessResponseInfo

参数

参数类型

描述

process_file_path

String

特权进程文件路径

请求示例

响应示例

状态码:200

请求已成功

{
  "protect_dir_info" : {
    "protect_dir_list" : [ {
      "protect_dir" : "/root/test1",
      "local_backup_dir" : "/root/test2",
      "protect_status" : "open_failed",
      "error" : "The protected directory or backup directory was not found."
    }, {
      "protect_dir" : "/root/test3",
      "exclude_child_dir" : "pro",
      "exclude_file_path" : "path",
      "local_backup_dir" : "/root/test4",
      "protect_status" : "open_failed",
      "error" : "The protected directory or backup directory was not found."
    } ],
    "exclude_file_type" : "log;pid;text",
    "protect_mode" : "recovery"
  },
  "enable_timing_off" : true,
  "timing_off_config_info" : {
    "week_off_list" : [ 1, 2, 4, 6 ],
    "timing_range_list" : [ {
      "time_range" : "02:00-04:00",
      "description" : "close"
    }, {
      "time_range" : "12:05-14:00"
    } ]
  },
  "enable_rasp_protect" : true,
  "rasp_path" : "/usr/bin/tomcat/bin",
  "enable_privileged_process" : true,
  "privileged_child_status" : true,
  "privileged_process_path_list" : [ "/usr/bin/echo" ]
}

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
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 ShowWebTamperHostPolicySolution {

    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();
        ShowWebTamperHostPolicyRequest request = new ShowWebTamperHostPolicyRequest();
        request.withHostId("{host_id}");
        try {
            ShowWebTamperHostPolicyResponse response = client.showWebTamperHostPolicy(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
# 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 = ShowWebTamperHostPolicyRequest()
        request.host_id = "{host_id}"
        response = client.show_web_tamper_host_policy(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
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.ShowWebTamperHostPolicyRequest{}
	request.HostId = "{host_id}"
	response, err := client.ShowWebTamperHostPolicy(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码