文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 网页防篡改/ 导出网页防篡改防护目录列表 - ExportWebTamperHost
更新时间：2025-10-31 GMT+08:00
查看PDF
分享

导出网页防篡改防护目录列表 - ExportWebTamperHost

功能介绍

导出网页防篡改防护目录列表

授权信息

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

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

URI

POST /v5/{project_id}/webtamper/host/export

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

参数

是否必选

参数类型

描述

host_id

否

String

参数解释：

主机ID

取值范围：

字符长度1-64位

host_id_list

否

Array of strings

参数解释:

服务器ID列表

取值范围:

不涉及

host_name

否

String

参数解释:

服务器名称

取值范围:

字符长度1-256位

public_ip

否

String

参数解释：

弹性公网IP地址

取值范围：

字符长度1-256位

private_ip

否

String

参数解释：

服务器私有IP

取值范围：

字符长度1-128位

agent_id

否

String

参数解释:

Agent ID。（已废弃，请使用host_id）

约束限制:

不涉及

取值范围:

字符长度1-64位

默认取值:

不涉及

os_type

否

String

参数解释：

操作系统类型

取值范围：

  • Linux：Linux。

  • Windows：Windows。

asset_value

否

String

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

  • important ：重要资产

  • common ：一般资产

  • test ：测试资产

group_name

否

String

参数解释:

服务器组名称

取值范围:

字符长度0-256位

protect_status

否

String

防护状态。（已废弃，请使用wtp_status）

agent_status

否

String

参数解释:

Agent状态。

约束限制:

不涉及

取值范围:

  • not_installed：未安装。

  • online：在线。

  • offline：离线。

默认取值:

不涉及。

rasp_protect_status

否

String

动态网页防篡改防护状态

  • opened : 防护中

  • closed : 未防护

wtp_status

否

String

参数解释:

网页防篡改防护状态

取值范围:

  • opening : 开启中。

  • opened : 防护中。

  • open_failed : 防护失败。

  • partial_protection : 部分防护。

  • protection_interruption : 防护中断。

offset

否

Integer

偏移量。（已废弃，请使用export_size）

limit

否

Integer

每页显示个数。（已废弃，请使用export_size）

export_headers

是

Array<Array<String>>

参数解释:

导出数据表头信息详情

约束限制:

表头信息应为如下格式[[字段1,表头1显示名称],[字段2,表头2显示名称],[字段3,表头3显示名称]]

取值范围:

可从如下取值中选取部分或全部组成表头信息

  • host_name：服务器名称。

  • host_id：服务器ID。

  • public_ip：弹性公网IP地址。

  • private_ip：私有IP地址。

  • charging_mode：计费模式。

  • agent_status：Agent状态。

  • protect_status：防护状态。

  • protect_dir_num：防护目录数。

  • rasp_protect_status：动态防篡改状态。

  • anti_tampering_times：静态防篡改攻击（近七天）。

  • detect_tampering_times：动态防篡改攻击（近七天）。

  • protect_dir：防护目录。

  • exclude_child_dir：排除子目录。

  • exclude_file_list：排除文件路径列表。

  • local_backup_dir：本地备份路径。

  • exclude_file_type：排除文件类型。

  • dir_protect_status：防护目录状态。

  • error：错误信息。

默认取值:

不涉及

export_size

是

Integer

参数解释:

导出数据条数上限

约束限制:

不涉及

取值范围:

最小值1，最大值200000

默认取值:

不涉及

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

task_id

String

参数解释：

导出任务的ID

取值范围：

字符长度0-128位

请求示例

导出网页防篡改防护目录列表。

POST https://{endpoint}/v5/{project_id}/webtamper/host/export

{
  "export_size" : 10,
  "export_headers" : [ [ "host_name", "服务器名称" ], [ "host_id", "服务器ID" ] ]
}

响应示例

状态码：200

请求已成功

{
  "task_id" : "9e8***4-d26b-426d-a2be-765930242984"
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

父主题： 网页防篡改

相关文档