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

编辑网页防篡改策略信息 - UpdateWebTamperHostPolicy

功能介绍

编辑网页防篡改策略信息

授权信息

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

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

host_id

String

参数解释:

服务器ID,要求服务器已开启网页防篡改防护

约束限制:

需要使用 ListWtpProtectHost 接口查询网页防篡改主机防护状态列表信息,在 ListWtpProtectHost 接口的响应体中,protect_status 等于 opened,open_failed,protection_pause或partial_protection 的 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位

默认取值:

不涉及

表4 请求Body参数

参数

是否必选

参数类型

描述

protect_dir_info

WebTamperProtectDirRequestInfo object

防护目录信息

enable_timing_off

Boolean

参数解释:

定时开关设置状态

约束限制:

不涉及

取值范围:

  • True :开启定时关闭防护功能,必须填写timing_off_config_info。

  • False :关闭定时关闭防护功能,无需填写timing_off_config_info。

默认取值:

False

timing_off_config_info

WebTamperTimingOffConfigInfoRequestInfo object

定时开关配置详情

enable_rasp_protect

Boolean

参数解释:

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

约束限制:

仅Linux服务器支持开启动态网页防篡改,Windows服务器不可填写该字段。

取值范围:

  • True :开启动态网页防篡改,必须填写rasp_path。

  • False :关闭动态网页防篡改,无需填写rasp_path。

默认取值:

False

rasp_path

String

参数解释:

动态网页防篡改的Tomcat bin目录,仅Linux服务器支持。

约束限制:

仅Linux服务器支持配置动态网页防篡改的Tomcat bin目录,Windows服务器不可填写该字段。

取值范围:

字符长度1-256位,必须以/开头,不能以/结尾,只能包含英文大小写字母,数字,下划线,中划线和点。

默认取值:

不涉及

enable_privileged_process

Boolean

参数解释:

特权进程开启状态

约束限制:

不涉及

取值范围:

  • True :开启特权进程,必须填写privileged_process_info。

  • False :关闭特权进程,无需填写privileged_process_info。

默认取值:

False

privileged_process_info

WebTamperPrivilegedProcessRequestInfo object

特权进程配置详情

表5 WebTamperProtectDirRequestInfo

参数

是否必选

参数类型

描述

protect_dir_list

Array of WebTamperProtectHostDirRequestInfo objects

参数解释:

防护目录列表

约束限制:

不涉及

取值范围:

最少1条,最多50条

默认取值:

不涉及

exclude_file_type

String

参数解释:

排除文件类型

约束限制:

不涉及

取值范围:

文件类型只能输入字母、数字,最多支持10个文件类型,每个文件类型长度不超过10个字符,多个文件类型以分号隔开。

默认取值:

不涉及

protect_mode

String

参数解释:

防护模式,仅Linux服务器支持设置防护模式为告警模式,Windows服务器仅支持拦截模式。

约束限制:

不涉及

取值范围:

  • recovery :拦截模式。

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

默认取值:

recovery

表6 WebTamperProtectHostDirRequestInfo

参数

是否必选

参数类型

描述

protect_dir

String

参数解释:

防护目录

约束限制:

不涉及

取值范围:

字符长度1-256位。Linux服务器,必须以/开头,不能以/结尾,只能包含英文大小写字母,数字,下划线,中划线和点。Windows服务器,目录名不能包含;/*?"<>|,不能以空格开头,不能以\结尾。

默认取值:

不涉及

exclude_child_dir

String

参数解释:

排除子目录

约束限制:

不涉及

取值范围:

子目录名必须是防护目录的有效相对路径,目录名最大长度不能超过256个字符,最多可添加10个子目录,多个子目录用;隔开。Linux服务器的子目录名不能以/开头或结尾,Windows服务器的子目录名不能以\开头或结尾。

默认取值:

不涉及

exclude_file_path

String

参数解释:

排除文件路径

约束限制:

仅Linux服务器支持填写排除文件路径,Windows服务器不可填写该字段。

取值范围:

排除文件路径必须是防护目录的有效相对路径,不能以/开头或结尾,文件路径最大长度不能超过256个字符;最多可添加50个文件路径,多个文件路径用;隔开。

默认取值:

不涉及

local_backup_dir

String

参数解释:

本地备份路径,Linux服务器必须填写该字段。

约束限制:

仅Linux服务器需要填写本地备份路径,Windows服务器不可填写该字段。

取值范围:

本地备份路径不能包含;字符,不能以空格开头,不能以/结尾,本地备份路径长度不得超过256个字符。

默认取值:

不涉及

表7 WebTamperTimingOffConfigInfoRequestInfo

参数

是否必选

参数类型

描述

week_off_list

Array of integers

参数解释:

自动关闭防护周期列表

约束限制:

不涉及

取值范围:

最少1条,最多7条

默认取值:

不涉及

timing_range_list

Array of TimingRangeConfigRequestInfo objects

参数解释:

自动关闭防护时间段

约束限制:

不涉及

取值范围:

最少1条,最多5条

默认取值:

不涉及

表8 TimingRangeConfigRequestInfo

参数

是否必选

参数类型

描述

time_range

String

参数解释:

自动关闭防护的时间段范围,开始时间与结束之间用中划线相连,如15:00-15:30。

约束限制:

每个时间段最短不能少于5分钟。多个时间段之间不允许重叠,且两段时间间隔必须大于5分钟(时间00:00和23:59特例除外)。

取值范围:

字符长度0-20位

默认取值:

不涉及

description

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度0-20位

默认取值:

不涉及

表9 WebTamperPrivilegedProcessRequestInfo

参数

是否必选

参数类型

描述

privileged_process_path_list

Array of strings

参数解释:

特权进程文件路径列表

约束限制 :

不涉及

取值范围:

最少0条,最多10条

默认取值 :

不涉及

privileged_child_status

Boolean

参数解释:

特权进程子进程可信状态

约束限制 :

不涉及

取值范围:

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

  • False :关闭特权进程子进程可信。

默认取值 :

False

响应参数

状态码:200

请求已成功

请求示例

编辑网页防篡改策略信息。

PUT https://{endpoint}/v5/{project_id}/webtamper/{host_id}/policy

{
  "protect_dir_info" : {
    "protect_dir_list" : [ {
      "local_backup_dir" : "/root/test2",
      "protect_dir" : "/root/test1"
    }, {
      "exclude_child_dir" : "pro",
      "exclude_file_path" : "path",
      "local_backup_dir" : "/root/test4",
      "protect_dir" : "/root/test3"
    } ],
    "exclude_file_type" : "log;pid;text",
    "protect_mode" : "recovery"
  },
  "enable_timing_off" : true,
  "enable_privileged_process" : true,
  "enable_rasp_protect" : true,
  "timing_off_config_info" : {
    "week_off_list" : [ 5, 7 ],
    "timing_range_list" : [ {
      "time_range" : "02:00-04:00",
      "description" : "close"
    }, {
      "time_range" : "12:05-14:00"
    } ]
  },
  "privileged_process_info" : {
    "privileged_process_path_list" : [ "/usr/bin/echo" ],
    "privileged_child_status" : true
  },
  "rasp_path" : "/usr/bin/tomcat/bin"
}

响应示例

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档