Querying the Protection Period, Virus Database Update Time, Vulnerability Database Update Time, and Accumulated Number of Records of Each Module
Function
This API is used to query the protection period, virus database update time, vulnerability database update time, and accumulated number of records of each module.
Calling Method
For details, see Calling APIs.
URI
GET /v5/{project_id}/overview/protection/statistics
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. |
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 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
vul_library_update_time |
Long |
Definition Vulnerability database update time. Range Minimum value: 0; maximum value: 4071095999000 |
protect_days |
Long |
Definition Protection period, in days Range Minimum value: 0; maximum value: 4071095999000 |
threat_library_update_time |
Long |
Definition Last virus database update Range Minimum value: 0; maximum value: 4071095999000 |
vul_detected_total_num |
Long |
Definition Accumulated number of detected vulnerabilities. Range Minimum value: 0; maximum value: 4071095999000 |
baseline_detected_total_num |
Long |
Definition Accumulated number of checked baseline items. Range Minimum value: 0; maximum value: 4071095999000 |
finger_scan_total_num |
Long |
Definition Accumulated number of scanned fingerprints. Range Minimum value: 0; maximum value: 4071095999000 |
alarm_detected_total_num |
Long |
Definition Accumulated number of intrusion detection alarms. Range Minimum value: 0; maximum value: 4071095999000 |
ransomware_alarm_detected_total_num |
Long |
Definition Accumulated number of ransomware alarms. Range Minimum value: 0; maximum value: 4071095999000 |
file_alarm_detected_total_num |
Long |
Definition Accumulated number of file change alarms detected by file integrity monitoring. Range Minimum value: 0; maximum value: 4071095999000 |
rasp_alarm_detected_total_num |
Long |
Definition Accumulated number of application protection alarms. Range Minimum value: 0; maximum value: 4071095999000 |
wtp_alarm_detected_total_num |
Long |
Definition Accumulated number of blocked web tamper protection attacks. Range Minimum value: 0; maximum value: 4071095999000 |
image_risk_total_num |
Long |
Definition Accumulated number of detected container image security risks. Range Minimum value: 0; maximum value: 4071095999000 |
container_alarm_total_num |
Long |
Definition Accumulated number of container alarms detected by container security. Range Minimum value: 0; maximum value: 4071095999000 |
container_firewall_policy_total_num |
Long |
Definition Accumulated number of container firewall policies. Range Minimum value: 0; maximum value: 4071095999000 |
auto_kill_virus_status |
Boolean |
Definition Whether to enable automatic malicious process detection and removal. Range
|
Example Requests
Query the protection period, virus database update time, vulnerability database update time, and accumulated number of records of each module.
GET https://{endpoint}/v5/{project_id}/overview/protection/statistics
Example Responses
Status code: 200
Request succeeded.
{ "vul_library_update_time" : 1757468250000, "threat_library_update_time" : 1740708601000, "protect_days" : 1947, "vul_detected_total_num" : 112734, "baseline_detected_total_num" : 2042297, "finger_scan_total_num" : 1097850, "alarm_detected_total_num" : 663286, "ransomware_alarm_detected_total_num" : 0, "file_alarm_detected_total_num" : 749, "rasp_alarm_detected_total_num" : 54268, "wtp_alarm_detected_total_num" : 130876, "image_risk_total_num" : 751368, "container_alarm_total_num" : 487864, "container_firewall_policy_total_num" : 18, "auto_kill_virus_status" : true, "antivirus_malware_total_num" : 14421 }
SDK Sample Code
The SDK sample code is as follows.
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 ShowProtectStatisticsSolution { 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(); ShowProtectStatisticsRequest request = new ShowProtectStatisticsRequest(); try { ShowProtectStatisticsResponse response = client.showProtectStatistics(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()); } } } |
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 = ShowProtectStatisticsRequest() response = client.show_protect_statistics(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
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.ShowProtectStatisticsRequest{} response, err := client.ShowProtectStatistics(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