文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 网页防篡改/ 创建网页防篡改防护配置 - CreateWebTamperProtectionConfig
更新时间:2025-11-28 GMT+08:00
分享

创建网页防篡改防护配置 - CreateWebTamperProtectionConfig

功能介绍

创建网页防篡改防护配置

授权信息

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

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

URI

POST /v5/{project_id}/webtamper/protection-configs

表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参数

参数

是否必选

参数类型

描述

type

String

参数解释:

网页防篡改的类型

约束限制:

不涉及

取值范围:

  • container_wtp:容器网页防篡改

默认取值:

不涉及

protect_mode

String

参数解释:

防护模式

约束限制:

不涉及

取值范围:

  • alarm:告警模式

  • block:拦截模式

默认取值:

alarm

monitor_process

Boolean

参数解释:

是否对篡改行为进行进程监控

约束限制:

不涉及

取值范围:

  • true:监控篡改进程

  • false:不监控篡改进程

默认取值:

true

privileged_process_list

Array of strings

参数解释:

特权进程路径列表

约束限制:

monitor_process值为true时生效(不进行进程监控无法判断特权进程)

取值范围:

最少0条,最多10条

默认取值:

不涉及

privileged_child

Boolean

参数解释:

特权进程的子进程是否仍享有特权

约束限制:

monitor_process值为true时生效(不进行进程监控无法判断特权进程)

取值范围:

  • true:特权进程的子进程依然是特权进程

  • false:特权进程的子进程不再是特权进程

默认取值:

false

container_wtp_info

container_wtp_info object

参数解释:

容器网页防篡改相关配置信息

约束限制:

type值为“container_wtp”容器网页防篡改时有效

取值范围:

不涉及

默认取值:

不涉及

open_protection_immediately

Boolean

参数解释:

是否立即开启防护

约束限制:

不涉及

取值范围:

  • true:立即开启防护

  • false:只保存配置内容,暂不开启防护

默认取值:

false

quota_info

quota_info object

参数解释:

开启防护时绑定的配额信息

约束限制:

open_protection_immediately值为true时有效

取值范围:

不涉及

默认取值:

不涉及

表5 container_wtp_info

参数

是否必选

参数类型

描述

protect_type

String

参数解释:

防护类型

约束限制:

不涉及

取值范围:

  • cluster:对集群下的容器进行网页防篡改防护

  • host:对主机下的容器进行网页防篡改防护

默认取值:

不涉及

web_app_name

String

参数解释:

网站应用的名称

约束限制:

不涉及

取值范围:

字符长度1-128位

默认取值:

不涉及

cluster_id

String

参数解释:

集群id

约束限制:

protect_type值为“cluster”时有效

取值范围:

字符长度1-64位

默认取值:

不涉及

host_id

String

参数解释:

主机id

约束限制:

protect_type值为“host”时有效

取值范围:

字符长度1-64位

默认取值:

不涉及

cluster_label_list

Array of ClusterLabelInfo objects

参数解释:

集群标签列表

约束限制:

protect_type值为“cluster”时生效

取值范围:

最少0条,最多10条

默认取值:

不涉及

protect_image_list

Array of ProtectImageInfo objects

参数解释:

防护的镜像列表

约束限制:

不涉及

取值范围:

最少1条,最多10条

默认取值:

不涉及

表6 ClusterLabelInfo

参数

是否必选

参数类型

描述

key

String

参数解释:

集群资源标签的键名

约束限制:

不涉及

取值范围:

字符长度1-64位

默认取值:

不涉及

value

String

参数解释:

集群资源标签的值

约束限制:

不涉及

取值范围:

字符长度0-128位

默认取值:

不涉及

表7 ProtectImageInfo

参数

是否必选

参数类型

描述

image_name

String

参数解释

镜像名称

约束限制:

不涉及

取值范围

字符长度1-256位

默认取值:

不涉及

image_version

String

参数解释

镜像版本

约束限制:

不涉及

取值范围

字符长度0-64位

默认取值:

不涉及

image_type

String

参数解释

镜像类型

约束限制:

不涉及

取值范围

  • registry 仓库镜像

  • local 本地镜像

  • custom 自定义镜像

默认取值:

custom

protect_directory_info_list

Array of ProtectDirectoryInfo objects

参数解释

防护目录信息

约束限制:

不涉及

取值范围

最少1条,最多50条

默认取值:

不涉及

exclude_file_types

Array of strings

参数解释

防护排除的文件类型列表

约束限制:

不涉及

取值范围

最少0条,最多10条

默认取值:

不涉及

表8 ProtectDirectoryInfo

参数

是否必选

参数类型

描述

protect_directory

String

参数解释

防护目录

约束限制:

不涉及

取值范围

字符长度1-256位

默认取值:

不涉及

exclude_child_directory_list

Array of strings

参数解释

需要排除的子目录列表

约束限制:

不涉及

取值范围

最少0条,最多10条

默认取值:

不涉及

exclude_file_list

Array of strings

参数解释

需要排除的子文件列表

约束限制:

不涉及

取值范围

最少0条,最多10条

默认取值:

不涉及

backup_directory

String

参数解释

备份目录

约束限制:

不涉及

取值范围

字符长度1-256位

默认取值:

不涉及

表9 quota_info

参数

是否必选

参数类型

描述

charging_mode

String

参数解释:

计费模式

约束限制:

不涉及

取值范围:

  • packet_cycle:包年包月

默认取值:

不涉及

resource_id_list

Array of strings

参数解释:

配额id列表

约束限制:

若该字段值为空,则随机选取配额

取值范围:

最少0条,最多10条

默认取值:

不涉及

响应参数

状态码:200

请求已成功

请求示例

响应示例

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档