Viewing Handled Vulnerabilities
Function
This API is used to query vulnerabilities handled today versus total handled vulnerabilities.
Calling Method
For details, see Calling APIs.
URI
GET /v5/{project_id}/vulnerability/handle/vulnerabilities
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 |
---|---|---|---|
limit |
No |
Integer |
Parameter description: Number of records displayed on each page. Constraints: N/A Options: Value range: 10-200 Default value: 10 |
offset |
No |
Integer |
Definition Offset, which specifies the start position of the record to be returned. Constraints N/A Range The value range is 0 to 2,000,000. Default Value The default value is 0. |
vul_name |
No |
String |
Definition Vulnerability name. Constraints N/A Range Length: 0 to 256 characters Default Value N/A |
cve_id |
No |
String |
Definition CVE ID. Constraints N/A Range Length: 1 to 128 characters Default Value N/A |
label_list |
No |
String |
Definition Vulnerability tag. Constraints N/A Range Length: 0 to 128 characters Default Value N/A |
status |
No |
String |
Definition Vulnerability status. Constraints N/A Range
Default Value N/A |
asset_value |
No |
String |
Definition Asset importance. Constraints N/A Range
Default Value N/A |
group_name |
No |
String |
Definition Server group name. Constraints N/A Range Length: 1 to 128 characters Default Value N/A |
host_name |
No |
String |
Definition Server name. Constraints N/A Range Length: 1 to 128 characters Default Value N/A |
host_ip |
No |
String |
Definition Server IP address. Constraints N/A Range Length: 0 to 128 characters Default Value N/A |
type |
No |
String |
Definition Vulnerability type. Constraints N/A Range Length: 1 to 64 characters Default Value N/A |
handle_circle |
No |
String |
Definition Processing period. Constraints N/A Range
Default Value N/A |
repair_priority |
No |
String |
Definition Fixing priority. Constraints N/A Range
Default Value N/A |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
data_list |
Array of data_list objects |
array |
total_num |
Integer |
Definition Total number. Range Minimum value: 0; maximum value: 10000000 |
Parameter |
Type |
Description |
---|---|---|
label_list |
Array of strings |
Definition Vulnerability tag list. Range Minimum value: 0; maximum value: 2147483647 |
repair_priority |
String |
Definition Fixing priority. Range
|
repair_success_num |
Integer |
Definition Number of successful fixes of the current vulnerability. Range Minimum value: 0; maximum value: 1000000 |
vul_id |
String |
Definition Vulnerability ID. Range The value can contain 0 to 64 characters. |
vul_name |
String |
Definition Vulnerability name. Range The value can contain 0 to 256 characters. |
cve_list |
Array of cve_list objects |
Definition CVE list. Range Minimum value: 1; maximum value: 10000 |
is_affected_business |
Boolean |
Definition Whether services are affected. Range
|
host_id |
String |
Definition Host ID. Range Length: 1 to 64 characters |
public_ip |
String |
Definition Server EIP. Range Length: 0 to 128 characters |
private_ip |
String |
Definition Server private IP address. Range Length: 0 to 128 characters |
host_name |
String |
Definition Server name Range Length: 1 to 128 characters |
asset_value |
String |
Definition Fixing priority. Range
|
status |
String |
Definition Vulnerability status. Range Length: 0 to 32 characters |
first_scan_time |
Long |
Definition First scan time. Range Minimum value: 0; maximum value: 9223372036854775807 |
scan_time |
Long |
Definition Last scan time. Range Minimum value: 0; maximum value: 9223372036854775807 |
disabled_operate_types |
Array of disabled_operate_types objects |
Definition List of operations that cannot be performed on a vulnerability. Range Minimum value: 1; maximum value: 10000 |
Parameter |
Type |
Description |
---|---|---|
cve_id |
String |
Definition CVE ID Range The value can contain 1 to 32 characters. |
cvss |
Float |
Definition CVSS score. Range Minimum value: 0; maximum value: 10 |
Parameter |
Type |
Description |
---|---|---|
operate_type |
String |
Definition Operation type. Range
|
reason |
String |
Definition Reason why an operation cannot be performed. Range The value can contain 0 to 512 characters. |
Example Requests
None
Example Responses
Status code: 200
Request succeeded.
{ "data_list" : [ { "status" : "vul_status_fixed", "description" : "The kernel package contains the Linux kernel (vmlinuz), the core of any Linux operating system.", "version" : "hss.version.premium", "host_id" : "17300e07-da2a-4d74-87c5-b6fad8a18704", "agent_id" : "5388b0d5f5c631e0584cbaad9d2e55ab77f1460fe9d9ffc90cfe578354411717", "host_name" : "ecs-00896674", "group_name" : "1111111111111111", "asset_value" : "common", "scan_time" : 1734439020824, "private_ip" : "192.168.0.217", "public_ip" : "100.93.7.22", "vul_name" : "EulerOS-SA-2024-2832 kernel security update", "vul_id" : "EulerOS-SA-2024-2832", "label_list" : [ "Restart required.", "Vulnerabilities are easy to exploit.", "Remote network attack", "Competition condition" ], "severity_level" : "Critical", "repair_success_num" : 0, "cve_list" : [ { "cvss" : 5.5, "cve_id" : "CVE-2020-36777" }, { "cvss" : 7.8, "cve_id" : "CVE-2024-44987" } ], "is_affect_business" : "false,", "first_scan_time" : "1733363485076,", "support_restore" : "false,", "repair_priority" : "High" } ], "total_num" : 1 }
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 ListHandleVulsSolution { 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(); ListHandleVulsRequest request = new ListHandleVulsRequest(); try { ListHandleVulsResponse response = client.listHandleVuls(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 = ListHandleVulsRequest() response = client.list_handle_vuls(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.ListHandleVulsRequest{} response, err := client.ListHandleVuls(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