Querying Static WTP Events
Function
This API is used to query static WTP events.
Calling Method
For details, see Calling APIs.
URI
GET /v5/{project_id}/webtamper/static/protect-history
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project. |
host_id |
No |
String |
Definition Server ID. Constraints N/A Range The value can contain 1 to 64 characters. Default Value N/A |
host_name |
No |
String |
Definition Server name. Constraints N/A Range The value contains 1 to 256 characters. Default Value N/A |
host_ip |
No |
String |
Definition Server IP address Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A |
file_path |
No |
String |
Definition Path of the protected file. Constraints N/A Range Length: 0 to 128 characters Default Value N/A |
file_operation |
No |
String |
Definition Event description, that is, file operation type. Constraints N/A Range
Default Value N/A |
start_time |
Yes |
Long |
Definition Start time of the query, in milliseconds. The start time cannot be earlier than 30 days ago. If an earlier time is specified, the query range is still the past 30 days. Constraints N/A Range The value range is 0 to 4,070,880,000,000. Default Value N/A |
end_time |
Yes |
Long |
Definition End time of the query, in milliseconds. The end time cannot be earlier than the start time. The difference between the end time and start time cannot exceed 30 days. If it exceeds 30 days, the end time is set to one day later than the start time. Constraints N/A Range The value range is 0 to 4,070,880,000,000. Default Value N/A |
limit |
Yes |
Integer |
Definition Number of records displayed on each page. Constraints N/A Range Value range: 10 to 200 Default Value 10 |
offset |
Yes |
Integer |
Definition Offset, which specifies the start position of the record to be returned. Constraints N/A Range Minimum value: 0; maximum value: 2000000 Default Value 0 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A |
region |
No |
String |
Definition Region ID, which is used to query assets in the required region. For details about how to obtain a region ID, see Obtaining a Region ID. Constraints N/A Range The value can contain 1 to 128 characters. Default Value N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total_num |
Integer |
Definition Total number. Range The value range is 0 to 2,147,483,647. |
data_list |
Array of HostProtectHistoryResponseInfo objects |
Definition Static web tamper protection event list Range Minimum value: 0; maximum value: 200 |
Parameter |
Type |
Description |
---|---|---|
host_name |
String |
Definition Server name. Range The value can contain 1 to 256 characters. |
occr_time |
Long |
Definition Detection time, in milliseconds. (This parameter has been discarded. Use occur_time instead.) Range Minimum value: 0; maximum value: 4070880000000 |
occur_time |
Long |
Definition Detection time, in milliseconds. Range Minimum value: 0; maximum value: 4070880000000 |
file_path |
String |
Definition Path of the protected file. Range Length: 0 to 2000 characters |
file_operation |
String |
Definition Event description, that is, file operation type. Range
|
host_ip |
String |
Definition Server IP address Range Length: 0 to 64 characters |
process_id |
Integer |
Definition Process ID. Range Minimum value: 0; maximum value: 2147483647 |
process_name |
String |
Definition Process name. Range Length: 0 to 200 characters |
process_cmd |
String |
Definition Process command line. Range Length: 0 to 8192 characters |
Example Requests
Query static WTP protection events. The target server ID is caa958ad-a481-4d46-b51e-6861b8864515, start time is 1735660800000, and end time is 1735747200000.
GET https://{endpoint}/v5/{project_id}/webtamper/static/protect-history { "host_id" : "caa958ad-a481-4d46-b51e-6861b8864515", "start_time" : 1735660800000, "end_time" : 1735747200000, "limit" : 10, "offset" : 0 }
Example Responses
Status code: 200
Request succeeded.
{ "host_name" : "ecs-ubuntu", "protect_status" : "opened", "total_num" : 1, "data_list" : [ { "occur_time" : 1735660800000, "file_path" : "/root/test/tamper/test.xml", "host_name" : "hss-test", "host_ip" : "192.168.5.98", "file_operation" : "add", "process_id" : 18672, "process_name" : "program1", "process_cmd" : "del test.xml" } ] }
SDK Sample Code
The SDK sample code is as follows.
Query static WTP protection events. The target server ID is caa958ad-a481-4d46-b51e-6861b8864515, start time is 1735660800000, and end time is 1735747200000.
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 ListHostProtectHistoryInfoSolution { 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(); ListHostProtectHistoryInfoRequest request = new ListHostProtectHistoryInfoRequest(); try { ListHostProtectHistoryInfoResponse response = client.listHostProtectHistoryInfo(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 static WTP protection events. The target server ID is caa958ad-a481-4d46-b51e-6861b8864515, start time is 1735660800000, and end time is 1735747200000.
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 = ListHostProtectHistoryInfoRequest() response = client.list_host_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 static WTP protection events. The target server ID is caa958ad-a481-4d46-b51e-6861b8864515, start time is 1735660800000, and end time is 1735747200000.
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.ListHostProtectHistoryInfoRequest{} response, err := client.ListHostProtectHistoryInfo(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 |
Request succeeded. |
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