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

查看网页防篡改策略信息 - ShowWebTamperHostPolicy

功能介绍

查看网页防篡改策略信息

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前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

参数解释:

动态网页防篡改开启状态,仅Linux服务器支持设置动态网页防篡改。

取值范围:

  • 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条

表5 WtpProtectDirResponseInfo

参数

参数类型

描述

protect_dir_list

Array of WtpProtectHostDirResponseInfo objects

参数解释:

防护目录列表

取值范围:

最少0条,最多50条

exclude_file_type

String

参数解释:

排除文件类型

取值范围:

字符长度0-512位

protect_mode

String

参数解释:

防护模式。

取值范围:

  • recovery :拦截模式。

  • alarm :告警模式,仅Linux服务器支持告警模式。

表6 WtpProtectHostDirResponseInfo

参数

参数类型

描述

protect_dir

String

参数解释:

防护目录

取值范围:

字符长度0-512位

exclude_child_dir

String

参数解释:

排除子目录

取值范围:

字符长度0-512位

exclue_file_path

String

排除文件路径

local_backup_dir

String

参数解释:

本地备份路径,仅Linux服务器支持设置本地备份路径。

取值范围:

字符长度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

参数解释:

自动关闭防护周期列表。1代表周一;2代表周二;3代表周三;4代表周四;5代表周五;6代表周六;7代表周日。

取值范围:

最少0条,最多7条

timing_range_list

Array of TimingRangeConfigInfo objects

参数解释:

自动关闭防护时间段

取值范围:

最少0条,最多5条

表8 TimingRangeConfigInfo

参数

参数类型

描述

time_range

String

参数解释:

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

取值范围:

字符长度0-512位

description

String

参数解释:

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

取值范围:

字符长度0-512位

请求示例

响应示例

状态码: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" ]
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档