文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 网页防篡改/ 查询防护配置关联的容器的防护目录列表 - ListWebTamperProtectionDirectory
更新时间：2025-11-28 GMT+08:00
查看PDF
分享

查询防护配置关联的容器的防护目录列表 - ListWebTamperProtectionDirectory

功能介绍

查询防护配置关联的容器的防护目录列表

授权信息

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

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

URI

GET /v5/{project_id}/webtamper/protection-directories

表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）。

type

是

String

参数解释:

网页防篡改类型

约束限制:

不涉及。

取值范围:

  • container_wtp：容器网页防篡改

默认取值:

不涉及

protection_config_id

是

String

参数解释:

防护配置id

约束限制:

不涉及。

取值范围:

字符长度1-64位

默认取值:

不涉及

container_id

否

String

参数解释:

受影响容器id

约束限制:

不涉及

取值范围:

字符长度0-256位

默认取值:

不涉及

offset

否

Integer

参数解释:

偏移量：指定返回记录的开始位置

约束限制:

不涉及

取值范围:

最小值0，最大值2000000

默认取值:

默认为0

limit

否

Integer

参数解释:

每页显示个数

约束限制:

不涉及

取值范围:

取值10-200

默认取值:

10

status

否

String

参数解释:

防护状态

约束限制:

type为container_wtp时必传

取值范围:

  • protected：防护中

  • protect_failed：防护失败

默认取值:

不涉及

protect_directory

否

String

参数解释:

防护目录

约束限制:

不涉及。

取值范围:

字符长度1-256位

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见获取用户Token。

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

total_num

Integer

参数解释:

防护配置关联的容器的防护目录总数

取值范围:

最小值0，最大值2147483647

data_list

Array of WebTamperProtectionDirectoryResponseInfo objects

参数解释:

防护配置关联的容器的防护目录列表

取值范围:

取值0-200个WebTamperProtectionDirectoryResponseInfo对象
表5 WebTamperProtectionDirectoryResponseInfo

参数

参数类型

描述

protect_directory

String

参数解释：

集群ID

取值范围：

字符长度1-256位

status

String

参数解释:

防护状态

取值范围:

  • protected：防护中

  • protect_failed：防护失败

failed_reason

String

参数解释：

防护失败原因

取值范围：

字符长度1-256位

backup_directory

String

参数解释：

本地备份路径

取值范围：

字符长度1-256位

exclude_child_directory_list

Array of strings

参数解释：

需要排除的子目录列表

取值范围：

最少0条，最多10条

exclude_file_list

Array of strings

参数解释：

需要排除的子文件列表

取值范围：

最少0条，最多10条

请求示例

无

响应示例

状态码：200

请求已成功

{
  "total_num" : 1,
  "data_list" : [ {
    "protect_directory" : "/root/www",
    "backup_directory" : "/var/temp/wtp_backup",
    "status" : "protected",
    "failed_reason" : "",
    "exclude_child_directory_list" : [ "/root/www/log" ],
    "exclude_file_list" : [ "/var/temp/wtp_backup" ]
  } ]
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

父主题： 网页防篡改

相关文档