查询防护列表
功能介绍
查询防护列表:查询网页防篡改主机防护状态列表信息
调用方法
请参见如何调用API。
URI
GET /v5/{project_id}/webtamper/hosts
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID 最小长度:0 最大长度:64 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enterprise_project_id |
否 |
String |
企业项目ID 最小长度:0 最大长度:64 |
host_name |
否 |
String |
服务器名称 最小长度:0 最大长度:256 |
host_id |
否 |
String |
主机ID 最小长度:0 最大长度:128 |
public_ip |
否 |
String |
弹性公网IP 最小长度:0 最大长度:128 |
private_ip |
否 |
String |
私有IP 最小长度:0 最大长度:128 |
group_name |
否 |
String |
服务器组名称 最小长度:0 最大长度:256 |
os_type |
否 |
String |
操作系统类别(linux,windows)
最小长度:0 最大长度:32 |
protect_status |
否 |
String |
防护状态
最小长度:0 最大长度:32 |
agent_status |
否 |
String |
客户端状态
最小长度:0 最大长度:32 |
limit |
否 |
Integer |
默认10 最小值:10 最大值:100 缺省值:10 |
offset |
否 |
Integer |
偏移量:指定返回记录的开始位置 最小值:0 最大值:100 缺省值:0 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 最小长度:1 最大长度:32768 |
region |
是 |
String |
Region Id 最小长度:0 最大长度:32 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
data_list |
Array of WtpProtectHostResponseInfo objects |
data list 数组长度:0 - 200000 |
total_num |
Integer |
total number of WTP protected servers 最小值:0 最大值:65535 |
参数 |
参数类型 |
描述 |
---|---|---|
host_name |
String |
服务器名称 最小长度:0 最大长度:256 |
host_id |
String |
主机ID 最小长度:0 最大长度:128 |
public_ip |
String |
弹性公网IP 最小长度:0 最大长度:128 |
private_ip |
String |
私有IP 最小长度:0 最大长度:128 |
ipv6 |
String |
私有IPv6地址 最小长度:0 最大长度:256 |
group_name |
String |
服务器组名称 最小长度:0 最大长度:256 |
os_bit |
String |
操作系统位数 最小长度:0 最大长度:8 |
os_type |
String |
操作系统(linux,windows) 最小长度:0 最大长度:32 |
protect_status |
String |
防护状态
最小长度:0 最大长度:32 |
rasp_protect_status |
String |
动态网页防篡改状态
最小长度:0 最大长度:32 |
anti_tampering_times |
Long |
已防御篡改攻击次数 最小值:0 最大值:2000000000 |
detect_tampering_times |
Long |
已发现篡改攻击 最小值:0 最大值:2000000000 |
last_detect_time |
Long |
最近检测时间(ms) 最小值:0 最大值:4070880000000 |
scheduled_shutdown_status |
String |
定时关闭防护开关状态
最小长度:0 最大长度:32 |
agent_status |
String |
Agent状态
最小长度:0 最大长度:32 |
请求示例
查询防护状态为开启,企业项目ID为XX的网页防篡改主机防护状态列表信息,默认查询第一页10条
GET https://{endpoint}/v5/{project_id}/webtamper/hosts?offset=XX&limit=XX&protect_status=opened&enterprise_project_id=XX { "protect_status" : "opened" }
响应示例
状态码: 200
OK
{ "total_num" : 1, "data_list" : [ { "host_name" : "test", "host_id" : "000411f9-42a7-4acd-80e6-f7b9d3db895f", "public_ip" : "", "private_ip" : "192.168.0.70,fe80::f816:3eff:fed4:c4d7", "ipv6" : "fe80::f816:3eff:fed4:c4d7", "group_name" : "testGroup", "os_bit" : "64", "os_type" : "Linux", "protect_status" : "opened", "rasp_protect_status" : "opened", "anti_tampering_times" : 0, "detect_tampering_times" : 0, "last_detect_time" : 0, "agent_status" : "online" } ] }
SDK代码示例
SDK代码示例如下。
查询防护状态为开启,企业项目ID为XX的网页防篡改主机防护状态列表信息,默认查询第一页10条
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 48 49 50 51 52 53 54 55 56 |
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 ListWtpProtectHostSolution { 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"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); HssClient client = HssClient.newBuilder() .withCredential(auth) .withRegion(HssRegion.valueOf("<YOUR REGION>")) .build(); ListWtpProtectHostRequest request = new ListWtpProtectHostRequest(); request.withEnterpriseProjectId("<enterprise_project_id>"); request.withHostName("<host_name>"); request.withHostId("<host_id>"); request.withPublicIp("<public_ip>"); request.withPrivateIp("<private_ip>"); request.withGroupName("<group_name>"); request.withOsType("<os_type>"); request.withProtectStatus("<protect_status>"); request.withAgentStatus("<agent_status>"); request.withLimit(<limit>); request.withOffset(<offset>); try { ListWtpProtectHostResponse response = client.listWtpProtectHost(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()); } } } |
查询防护状态为开启,企业项目ID为XX的网页防篡改主机防护状态列表信息,默认查询第一页10条
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 |
# 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"] credentials = BasicCredentials(ak, sk) client = HssClient.new_builder() \ .with_credentials(credentials) \ .with_region(HssRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListWtpProtectHostRequest() request.enterprise_project_id = "<enterprise_project_id>" request.host_name = "<host_name>" request.host_id = "<host_id>" request.public_ip = "<public_ip>" request.private_ip = "<private_ip>" request.group_name = "<group_name>" request.os_type = "<os_type>" request.protect_status = "<protect_status>" request.agent_status = "<agent_status>" request.limit = <limit> request.offset = <offset> response = client.list_wtp_protect_host(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
查询防护状态为开启,企业项目ID为XX的网页防篡改主机防护状态列表信息,默认查询第一页10条
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 48 49 50 51 52 53 54 55 56 57 |
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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := hss.NewHssClient( hss.HssClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListWtpProtectHostRequest{} enterpriseProjectIdRequest:= "<enterprise_project_id>" request.EnterpriseProjectId = &enterpriseProjectIdRequest hostNameRequest:= "<host_name>" request.HostName = &hostNameRequest hostIdRequest:= "<host_id>" request.HostId = &hostIdRequest publicIpRequest:= "<public_ip>" request.PublicIp = &publicIpRequest privateIpRequest:= "<private_ip>" request.PrivateIp = &privateIpRequest groupNameRequest:= "<group_name>" request.GroupName = &groupNameRequest osTypeRequest:= "<os_type>" request.OsType = &osTypeRequest protectStatusRequest:= "<protect_status>" request.ProtectStatus = &protectStatusRequest agentStatusRequest:= "<agent_status>" request.AgentStatus = &agentStatusRequest limitRequest:= int32(<limit>) request.Limit = &limitRequest offsetRequest:= int32(<offset>) request.Offset = &offsetRequest response, err := client.ListWtpProtectHost(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK |
错误码
请参见错误码。