Querying the Status of Dynamic WTP for a Server
Function
This API is used to query the status of dynamic WTP for a server.
Calling Method
For details, see Calling APIs.
URI
GET /v5/{project_id}/webtamper/rasp/protect-history
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_id |
No |
String |
Server ID. If this parameter is left empty, all the servers are queried. Minimum: 0 Maximum: 128 |
start_time |
Yes |
Long |
Start time (ms) Minimum: 0 Maximum: 4070880000000 |
end_time |
Yes |
Long |
End time (ms) Minimum: 0 Maximum: 4070880000000 |
limit |
Yes |
Integer |
limit Minimum: 0 Maximum: 100 |
offset |
Yes |
Integer |
Offset, which specifies the start position of the record to be returned. Minimum: 0 Maximum: 100 |
alarm_level |
No |
Integer |
Alarm severity. Its value can be:
Minimum: 0 Maximum: 100 |
severity |
No |
String |
Threat level. Its value can be:
Minimum: 0 Maximum: 32 |
protect_status |
No |
String |
Protection status.
Minimum: 0 Maximum: 32 |
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 |
---|---|---|
total_num |
Long |
total number of dynamic WTPs Minimum: 0 Maximum: 200000 |
data_list |
Array of HostRaspProtectHistoryResponseInfo objects |
data list Array Length: 0 - 200000 |
Parameter |
Type |
Description |
---|---|---|
host_ip |
String |
Server IP address Minimum: 0 Maximum: 64 |
host_name |
String |
Server name Minimum: 0 Maximum: 64 |
alarm_time |
Long |
Alarm time of dynamic WTP (ms) Minimum: 0 Maximum: 4070880000000 |
threat_type |
String |
Threat type Minimum: 0 Maximum: 64 |
alarm_level |
Integer |
Alarm severity Minimum: 0 Maximum: 100 |
source_ip |
String |
IP address of the attacker Minimum: 0 Maximum: 128 |
attacked_url |
String |
URL of the attack request Minimum: 0 Maximum: 2000 |
Example Requests
Query the dynamic WTP status of a server where target ID is caa958ad-a481-4d46-b51e-6861b8864515, start time is 1668563099000, and end time is 1668563199000.
GET https://{endpoint}/v5/{project_id}/webtamper/rasp/protect-history { "host_id" : "caa958ad-a481-4d46-b51e-6861b8864515", "start_time" : 1668563099000, "end_time" : 1668563199000, "limit" : 10, "offset" : 0 }
Example Responses
Status code: 200
successful response
{ "total_num" : 1, "data_list" : [ { "host_ip" : "192.168.5.98", "host_name" : "hss-test", "alarm_level" : 2, "alarm_time" : 1668394634000, "attacked_url" : "/vulns/001-dir-1.jsp", "source_ip" : "10.100.30.200", "threat_type" : "Path Traversal" } ] }
SDK Sample Code
The SDK sample code is as follows.
Query the dynamic WTP status of a server where target ID is caa958ad-a481-4d46-b51e-6861b8864515, start time is 1668563099000, and end time is 1668563199000.
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 |
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 ListHostRaspProtectHistoryInfoSolution { 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(); ListHostRaspProtectHistoryInfoRequest request = new ListHostRaspProtectHistoryInfoRequest(); request.withEnterpriseProjectId("<enterprise_project_id>"); request.withHostId("<host_id>"); request.withStartTime(<start_time>L); request.withEndTime(<end_time>L); request.withLimit(<limit>); request.withOffset(<offset>); request.withAlarmLevel(<alarm_level>); request.withSeverity("<severity>"); request.withProtectStatus("<protect_status>"); try { ListHostRaspProtectHistoryInfoResponse response = client.listHostRaspProtectHistoryInfo(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()); } } } |
Query the dynamic WTP status of a server where target ID is caa958ad-a481-4d46-b51e-6861b8864515, start time is 1668563099000, and end time is 1668563199000.
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 |
# 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 = ListHostRaspProtectHistoryInfoRequest() request.enterprise_project_id = "<enterprise_project_id>" request.host_id = "<host_id>" request.start_time = <start_time> request.end_time = <end_time> request.limit = <limit> request.offset = <offset> request.alarm_level = <alarm_level> request.severity = "<severity>" request.protect_status = "<protect_status>" response = client.list_host_rasp_protect_history_info(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Query the dynamic WTP status of a server where target ID is caa958ad-a481-4d46-b51e-6861b8864515, start time is 1668563099000, and end time is 1668563199000.
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 |
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.ListHostRaspProtectHistoryInfoRequest{} enterpriseProjectIdRequest:= "<enterprise_project_id>" request.EnterpriseProjectId = &enterpriseProjectIdRequest hostIdRequest:= "<host_id>" request.HostId = &hostIdRequest request.StartTime = int64(<start_time>) request.EndTime = int64(<end_time>) request.Limit = int32(<limit>) request.Offset = int32(<offset>) alarmLevelRequest:= int32(<alarm_level>) request.AlarmLevel = &alarmLevelRequest severityRequest:= "<severity>" request.Severity = &severityRequest protectStatusRequest:= "<protect_status>" request.ProtectStatus = &protectStatusRequest response, err := client.ListHostRaspProtectHistoryInfo(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 |
successful response |
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