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

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

功能介绍

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

调用方法

请参见如何调用API

授权信息

账号具备所有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" : ""
    }
  } ]
}

SDK代码示例

SDK代码示例如下。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.hss.v5.region.HssRegion;
import com.huaweicloud.sdk.hss.v5.*;
import com.huaweicloud.sdk.hss.v5.model.*;


public class ListWebTamperProtectionContainerSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        HssClient client = HssClient.newBuilder()
                .withCredential(auth)
                .withRegion(HssRegion.valueOf("<YOUR REGION>"))
                .build();
        ListWebTamperProtectionContainerRequest request = new ListWebTamperProtectionContainerRequest();
        try {
            ListWebTamperProtectionContainerResponse response = client.listWebTamperProtectionContainer(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkhss.v5.region.hss_region import HssRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkhss.v5 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = HssClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(HssRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListWebTamperProtectionContainerRequest()
        response = client.list_web_tamper_protection_container(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    hss "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := hss.NewHssClient(
        hss.HssClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListWebTamperProtectionContainerRequest{}
	response, err := client.ListWebTamperProtectionContainer(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档