# 查询网页防篡改防护配置列表 - ListWebTamperProtectionConfigs #### 功能介绍 查询网页防篡改防护配置列表。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-hss2.0/hss_02_0007.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-hss2.0/hss_02_0022.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI GET /v5/{project_id}/webtamper/protection-configs 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**: 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-hss2.0/hss_02_0024.html)。 **约束限制**: 不涉及 **取值范围**: 字符长度1-256位 **默认取值**: 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | enterprise_project_id | 否 | String | **参数解释**: 企业项目ID，用于过滤不同企业项目下的资产。获取方式请参见[获取企业项目ID](https://support.huaweicloud.com/api-hss2.0/hss_02_0027.html)。 如需查询所有企业项目下的资产请传参"all_granted_eps"。 **约束限制**: 开通企业项目功能后才需要配置企业项目ID参数。 **取值范围**: 字符长度1-256位 **默认取值**: 0，表示默认企业项目（default）。 | | offset | 否 | Integer | **参数解释**: 偏移量：指定返回记录的开始位置 **约束限制**: 不涉及 **取值范围**: 最小值0，最大值2000000 **默认取值**: 默认为0 | | limit | 否 | Integer | **参数解释**: 每页显示个数 **约束限制**: 不涉及 **取值范围**: 取值10-200 **默认取值**: 10 | | type | 是 | String | **参数解释**: 网页防篡改类型 **约束限制**: 不涉及。 **取值范围**: - container_wtp：容器网页防篡改 **默认取值**: 不涉及 | | id | 否 | String | **参数解释**: 网页防篡改配置ID **约束限制**: 不涉及 **取值范围**: 字符长度1-128位 **默认取值**: 不涉及 | | web_app_name | 否 | String | **参数解释**: 网站应用的名称 **约束限制**: 不涉及 **取值范围**: 字符长度1-128位 **默认取值**: 不涉及 | | image_name | 否 | String | **参数解释**: 镜像名称 **约束限制**: 不涉及 **取值范围**: 字符长度1-512位 **默认取值**: 不涉及 | | image_version | 否 | String | **参数解释**: 镜像版本 **约束限制**: 不涉及 **取值范围**: 字符长度1-128位 **默认取值**: 不涉及 | | protect_type | 否 | String | **参数解释**: 防护类型 **约束限制**: 不涉及。 **取值范围**: - cluster：集群范围内防护 - host：主机范围内防护 **默认取值**: 不涉及 | | status | 否 | String | **参数解释**: 防护状态 **约束限制**: 不涉及。 **取值范围**: - not_protect：未防护 - protected：防护中 - partial_protected：部分防护 - protect_failed：防护失败 - redundant：防护冗余 **默认取值**: 不涉及 | | cluster_name | 否 | String | **参数解释**: 集群名称 **约束限制**: 不涉及 **取值范围**: 字符长度0-256位 **默认取值**: 不涉及 | | cluster_id | 否 | String | **参数解释**： 集群id **约束限制**： 不涉及 **取值范围**： 字符长度0-128位 **默认取值**： 不涉及 | | host_name | 否 | String | **参数解释**: 服务器名称 **约束限制**: 不涉及 **取值范围**: 字符长度0-128位 **默认取值**: 不涉及 | | host_id | 否 | String | **参数解释**: 服务器ID **约束限制**: 不涉及 **取值范围**: 字符长度0-128位 **默认取值**: 不涉及 | | host_private_ip | 否 | String | **参数解释**: 主机私有IP **约束限制**: 不涉及 **取值范围**: 字符长度0-128位 **默认取值**: 不涉及 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**: 用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见[获取用户Token](https://support.huaweicloud.com/api-hss2.0/hss_02_0009.html)。 **约束限制**: 不涉及 **取值范围**: 字符长度1-32768位 **默认取值**: 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total_num | Integer | **参数解释**: 网页防篡改配置总数 **取值范围**: 最小值0，最大值2147483647 | | data_list | Array of [WebTamperProtectionConfigResponseInfo] objects | **参数解释**: 网页防篡改配置列表 **取值范围**: 最少0条，最多200条 | 表5WebTamperProtectionConfigResponseInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**: 网页防篡改配置id **取值范围**: 字符长度1-64位 | | protect_mode | String | **参数解释**: 防护模式 **取值范围**: - alarm：告警模式 - block：拦截模式 | | monitor_process | Boolean | **参数解释**: 是否对篡改行为进行进程监控 **取值范围**: - true：监控篡改进程 - false：不监控篡改进程 | | privileged_process_list | Array of strings | **参数解释**: 特权进程路径列表 **取值范围**: 最少0条，最多10条 | | privileged_child | Boolean | **参数解释**: 特权进程的子进程是否仍享有特权 **取值范围**: - true：特权进程的子进程依然是特权进程 - false：特权进程的子进程不再是特权进程 | | protect_directory_info_list | Array of [ProtectDirectoryResponseInfo] objects | **参数解释**： 防护目录信息 **取值范围**： 最少1条，最多50条 | | exclude_file_types | Array of strings | **参数解释**： 防护排除的文件类型列表 **取值范围**： 最少0条，最多10条 | | status | String | **参数解释**: 防护状态 **取值范围**: - not_protect：未防护 - protected：防护中 - partial_protected：部分防护 - protect_failed：防护失败 - redundant：防护冗余 | | protected_container_nums | Integer | **参数解释**: 防护中的容器数量 **取值范围**: 最小值0，最大值2147483647 | | protected_event_nums | Integer | **参数解释**: 当前防护配置产生的防护事件数量 **取值范围**: 最小值0，最大值2147483647 | | resource_id | String | **参数解释**: 防护配置绑定的配额id **取值范围**: 字符长度1-64位 | | container_wtp_info | [container_wtp_info] object | **参数解释**: 容器网页防篡改信息 **取值范围**: 不涉及 | 表6ProtectDirectoryResponseInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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位 | 表7container_wtp_info | 参数 | 参数类型 | 描述 | |:---|:---|:---| | web_app_name | String | **参数解释**： 网站应用名称 **取值范围**： 字符长度1-128位 | | image_name | String | **参数解释**： 镜像名称 **取值范围**： 字符长度1-512位 | | image_version | String | **参数解释**： 镜像版本 **取值范围**： 字符长度1-64位 | | image_type | String | **参数解释**： 镜像类型 **取值范围**： - registry 仓库镜像 - local 本地镜像 - custom 自定义镜像 | | protect_type | String | **参数解释**: 防护类型 **取值范围**: - cluster：对集群下的容器进行网页防篡改防护 - host：对主机下的容器进行网页防篡改防护 | | cluster_info | [cluster_info] object | **参数解释**： 防护配置对应的集群信息 **取值范围**： 不涉及 | | cluster_label_list | Array of [cluster_label_list] objects | **参数解释**: 集群标签列表 **取值范围**: 最少0条，最多10条 | | host_info | [host_info] object | **参数解释**： 防护配置对应的主机信息 **取值范围**： 不涉及 | 表8cluster_info | 参数 | 参数类型 | 描述 | |:---|:---|:---| | cluster_id | String | **参数解释**： 集群ID **取值范围**： 字符长度0-128位 | | cluster_name | String | **参数解释**： 集群名称 **取值范围**： 字符长度0-256位 | | cluster_version | String | **参数解释**： 集群版本 **取值范围**： 字符长度0-256位 | | cluster_type | String | **参数解释**： 集群类型 **取值范围**： - cce：cce集群 - ali：阿里云集群 - tencent：腾讯云集群 - azure：微软云集群 - aws：亚马逊集群 - self_built_hw：华为云自建集群 - self_built_idc：IDC自建集群 | 表9cluster_label_list | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释**: 集群资源标签的键名 **取值范围**: 字符长度1-64位 | | value | String | **参数解释**: 集群资源标签的值 **取值范围**: 字符长度0-128位 | 表10host_info | 参数 | 参数类型 | 描述 | |:---|:---|:---| | host_id | String | **参数解释**: 主机id **取值范围**: 字符长度1-128位 | | host_name | String | **参数解释**: 主机名称 **取值范围**: 字符长度1-256位 | | host_private_ip | String | **参数解释**: 主机私网ip **取值范围**: 字符长度1-128位 | #### 请求示例 无 #### 响应示例 **状态码：200** 请求已成功 ``` { "total_num" : 1, "data_list" : [ { "id" : "60axxxxx-0xxf-4xx1-be38-5exxxxx1362f", "protect_mode" : "alarm", "monitor_process" : true, "privileged_process_list" : [ "/usr/local/opa" ], "privileged_child" : false, "protect_directory_info_list" : [ { "protect_directory" : "/root/www", "exclude_child_directory_list" : [ "/root/www/log" ], "exclude_file_list" : [ "/root/www/image/logo.png" ], "backup_directory" : "/var/temp/wtp_backup" } ], "exclude_file_types" : [ "log" ], "status" : "not_protect", "protected_container_nums" : 14, "protected_event_nums" : 5, "resource_id" : "21axxxxx-0xxf-2xx1-be67-5exxxxx13783", "container_wtp_info" : { "image_name" : "registry-cbu.huawei.com/scc_hss_container/hostguard", "image_version" : "3.2.22.x86_64", "image_type" : "custom", "protect_type" : "cluster", "web_app_name" : "test", "host_info" : { "host_name" : "主机名称", "host_id" : "4fe31ffc-330d-11f1-a771-fa163e5eb651", "host_private_ip" : "127.0.0.1" }, "cluster_info" : { "cluster_id" : "44axxxxx-0xxf-2xx1-9067-5exxxxx13436", "cluster_name" : "my-cluster", "cluster_version" : "1.18.3", "cluster_type" : "cce" }, "cluster_label_list" : [ { "key" : "app_name", "value" : "test_app" } ] } } ] } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` 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 ListWebTamperProtectionConfigsSolution { 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("")) .build(); ListWebTamperProtectionConfigsRequest request = new ListWebTamperProtectionConfigsRequest(); try { ListWebTamperProtectionConfigsResponse response = client.listWebTamperProtectionConfigs(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()); } } } ``` - [Python] ``` # 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("")) \ .build() try: request = ListWebTamperProtectionConfigsRequest() response = client.list_web_tamper_protection_configs(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := hss.HssClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := hss.NewHssClient(hcClient) request := &model.ListWebTamperProtectionConfigsRequest{} response, err := client.ListWebTamperProtectionConfigs(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/HSS/sdk?api=ListWebTamperProtectionConfigs&version=v5)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求已成功 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-hss2.0/ErrorCode.html)。