Querying the Protection List
Function
This API is used to query the protection list.
Calling Method
For details, see Calling APIs.
URI
GET /v5/{project_id}/webtamper/hosts
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. Minimum: 0 Maximum: 64 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
Enterprise project ID. Minimum: 0 Maximum: 64 |
host_name |
No |
String |
Server name Minimum: 0 Maximum: 256 |
host_id |
No |
String |
Server ID Minimum: 0 Maximum: 128 |
public_ip |
No |
String |
EIP Minimum: 0 Maximum: 128 |
private_ip |
No |
String |
Private IP address Minimum: 0 Maximum: 128 |
group_name |
No |
String |
Server group name Minimum: 0 Maximum: 256 |
os_type |
No |
String |
OS type. Its value can be:
Minimum: 0 Maximum: 32 |
protect_status |
No |
String |
Protection status.
Minimum: 0 Maximum: 32 |
agent_status |
No |
String |
Agent status. Its value can be:
Minimum: 0 Maximum: 32 |
limit |
No |
Integer |
Default value: 10 Minimum: 10 Maximum: 100 Default: 10 |
offset |
No |
Integer |
Offset, which specifies the start position of the record to be returned. Minimum: 0 Maximum: 100 Default: 0 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a user token. Minimum: 1 Maximum: 32768 |
region |
Yes |
String |
Region Id Minimum: 0 Maximum: 32 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
data_list |
Array of WtpProtectHostResponseInfo objects |
data list Array Length: 0 - 200000 |
total_num |
Integer |
total number of WTP protected servers Minimum: 0 Maximum: 65535 |
Parameter |
Type |
Description |
---|---|---|
host_name |
String |
Server name Minimum: 0 Maximum: 256 |
host_id |
String |
Server ID Minimum: 0 Maximum: 128 |
public_ip |
String |
EIP Minimum: 0 Maximum: 128 |
private_ip |
String |
Private IP address Minimum: 0 Maximum: 128 |
ipv6 |
String |
Private IPv6 address Minimum: 0 Maximum: 256 |
group_name |
String |
Server group name Minimum: 0 Maximum: 256 |
os_bit |
String |
OS bit version Minimum: 0 Maximum: 8 |
os_type |
String |
OS (Linux or Windows) Minimum: 0 Maximum: 32 |
protect_status |
String |
Protection status. Its value can be:
Minimum: 0 Maximum: 32 |
rasp_protect_status |
String |
Dynamic WTP status.
Minimum: 0 Maximum: 32 |
anti_tampering_times |
Long |
Number of blocked tampering attacks Minimum: 0 Maximum: 2000000000 |
detect_tampering_times |
Long |
Number of detected tampering attacks Minimum: 0 Maximum: 2000000000 |
last_detect_time |
Long |
Latest detection time (ms) Minimum: 0 Maximum: 4070880000000 |
scheduled_shutdown_status |
String |
Status of scheduled protection.
Minimum: 0 Maximum: 32 |
agent_status |
String |
Agent status.
Minimum: 0 Maximum: 32 |
Example Requests
This API is used to query the 10 records on the first page of WTP status list of servers whose status is enabled and enterprise project ID is XX by default.
GET https://{endpoint}/v5/{project_id}/webtamper/hosts?offset=XX&limit=XX&protect_status=opened&enterprise_project_id=XX { "protect_status" : "opened" }
Example Responses
Status code: 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 Sample Code
The SDK sample code is as follows.
This API is used to query the 10 records on the first page of WTP status list of servers whose status is enabled and enterprise project ID is XX by default.
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()); } } } |
This API is used to query the 10 records on the first page of WTP status list of servers whose status is enabled and enterprise project ID is XX by default.
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) |
This API is used to query the 10 records on the first page of WTP status list of servers whose status is enabled and enterprise project ID is XX by default.
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) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot