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

查询防护配置关联的容器信息列表 - ListWebTamperProtectionContainer

功能介绍

查询防护配置关联的容器信息列表

授权信息

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

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

URI

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

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

protection_config_id

String

参数解释:

防护配置id

约束限制:

不涉及。

取值范围:

字符长度1-64位

默认取值:

不涉及

offset

Integer

参数解释:

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

约束限制:

不涉及

取值范围:

最小值0,最大值2000000

默认取值:

默认为0

limit

Integer

参数解释:

每页显示个数

约束限制:

不涉及

取值范围:

取值10-200

默认取值:

10

host_name

String

参数解释:

服务器名称

约束限制:

不涉及

取值范围:

字符长度0-128位

默认取值:

不涉及

host_id

String

参数解释:

服务器ID

约束限制:

不涉及

取值范围:

字符长度0-128位

默认取值:

不涉及

host_private_ip

String

参数解释:

主机私有IP

约束限制:

不涉及

取值范围:

字符长度0-128位

默认取值:

不涉及

container_name

String

参数解释:

容器名称

约束限制:

不涉及

取值范围:

字符长度0-128位

默认取值:

不涉及

container_id

String

参数解释:

受影响容器id

约束限制:

不涉及

取值范围:

字符长度0-256位

默认取值:

不涉及

status

String

参数解释:

防护状态

约束限制:

不涉及

取值范围:

  • protected:防护中

  • partial_protected:部分防护

  • protect_failed:防护失败

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total_num

Integer

参数解释:

防护配置关联的容器信息总数

取值范围:

最小值0,最大值2147483647

data_list

Array of WebTamperProtectionContainerResponseInfo objects

参数解释:

防护配置关联的容器信息列表

取值范围:

取值0-200个WebTamperProtectionContainerResponseInfo对象

表5 WebTamperProtectionContainerResponseInfo

参数

参数类型

描述

status

String

description: |

参数解释:

防护状态

取值范围:

  • protected:防护中

  • partial_protected:部分防护

  • protect_failed:防护失败

container_id

String

参数解释

容器ID

取值范围

字符长度1-256位

container_name

String

参数解释

容器名称

取值范围

字符长度1-256位

image_name

String

参数解释

镜像名称

取值范围

字符长度1-256位

image_version

String

参数解释

镜像版本

取值范围

字符长度1-256位

pod_name

String

参数解释

pod name

取值范围

字符长度1-256位

pod_ip

String

参数解释

pod ip

取值范围

字符长度1-256位

namespace

String

参数解释

命名空间

取值范围

字符长度1-256位

all_directory_nums

Integer

参数解释:

防护总目录数量

取值范围:

最小值0,最大值2147483647

protected_directory_nums

Integer

参数解释:

防护成功数量

取值范围:

最小值0,最大值2147483647

host_info

WebTamperEventHostInfo object

参数解释:

网页防篡改事件信息对应的主机信息

取值范围:

不涉及

cluster_info

WebTamperEventClusterInfo object

参数解释:

网页防篡改事件信息对应的集群信息

取值范围:

不涉及

表6 WebTamperEventHostInfo

参数

参数类型

描述

host_id

String

参数解释:

主机id

取值范围:

字符长度1-128位

host_name

String

参数解释:

主机名称

取值范围:

字符长度1-256位

public_ip

String

参数解释:

主机公网ip

取值范围:

字符长度1-128位

private_ip

String

参数解释:

主机私网ip

取值范围:

字符长度1-128位

asset_value

String

参数解释:

主机的资产重要性

取值范围:

  • important:重要资产

  • common:一般资产

  • test:测试资产

os_type

String

参数解释

操作系统类型

取值范围

包含如下2种。

  • Linux :Linux。

  • Windows :Windows。

os_name

String

参数解释:

系统名称

取值范围:

字符长度0-128位

host_status

String

参数解释:

服务器状态

取值范围:

包含如下4种。

  • ACTIVE :运行中。

  • SHUTOFF :关机。

  • BUILDING :创建中。

  • ERROR :故障。

agent_status

String

参数解释:

Agent状态

取值范围:

包含如下6种。

  • installed :已安装。

  • not_installed :未安装。

  • online :在线。

  • offline :离线。

  • install_failed :安装失败。

  • installing :安装中。

表7 WebTamperEventClusterInfo

参数

参数类型

描述

cluster_id

String

参数解释

集群ID

取值范围

字符长度1-128位

cluster_name

String

参数解释

集群名称

取值范围

字符长度1-256位

cluster_type

String

参数解释

集群类型

取值范围

字符长度1-128位

请求示例

响应示例

状态码:200

请求已成功

{
  "total_num" : 1,
  "data_list" : [ {
    "container_name" : "aa",
    "container_id" : "",
    "status" : "protected",
    "image_name" : "aa",
    "image_version" : "1.0",
    "pod_name" : "11",
    "pod_ip" : "",
    "namespace" : "",
    "host_info" : {
      "host_name" : "",
      "host_id" : "",
      "private_ip" : "",
      "public_ip" : "",
      "os_type" : "",
      "os_name" : "",
      "agent_status" : "",
      "host_status" : ""
    },
    "cluster_info" : {
      "cluster_name" : "",
      "cluster_id" : "",
      "cluster_type" : ""
    }
  } ]
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档