Exporting Information About Vulnerabilities and Their Affected Servers
Function
This API is used to export information about vulnerabilities and their affected servers.
Calling Method
For details, see Calling APIs.
URI
POST /v5/{project_id}/vul/export
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Tenant project ID. Minimum: 1 Maximum: 256 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
Enterprise user ID. To query all enterprise projects, set this parameter to all_granted_eps. Default: 0 Minimum: 0 Maximum: 256 |
type |
No |
String |
Vulnerability type. The options are as follows: -linux_vul: Linux vulnerability -windows_vul: Windows vulnerability -web_cms: Web-CMS vulnerability -app_vul: application vulnerability -urgent_vul: emergency vulnerability Minimum: 0 Maximum: 32 |
vul_id |
No |
String |
Vulnerability ID. Minimum: 0 Maximum: 256 |
vul_name |
No |
String |
Vulnerability name. Minimum: 0 Maximum: 256 |
host_id |
No |
String |
Server ID, which will be used when vulnerabilities of a single server are exported. Minimum: 0 Maximum: 256 |
limit |
No |
Integer |
limit Minimum: 0 Maximum: 500 |
offset |
No |
Integer |
Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0. Minimum: 0 Maximum: 2000000 Default: 0 |
repair_priority |
No |
String |
Fixing priority. Its value can be: Critical High Medium Low Minimum: 1 Maximum: 256 |
handle_status |
No |
String |
Handling status. It can be:
Default: unhandled Minimum: 1 Maximum: 32 |
cve_id |
No |
String |
Vulnerability ID. Minimum: 0 Maximum: 128 |
label_list |
No |
String |
Vulnerability tag. Minimum: 0 Maximum: 128 |
status |
No |
String |
Vulnerability status. Minimum: 0 Maximum: 32 |
asset_value |
No |
String |
Asset importance. Its value can be: important common test Minimum: 0 Maximum: 32 |
group_name |
No |
String |
Server group name. Minimum: 0 Maximum: 256 |
export_size |
Yes |
Integer |
Number of exported data records. Minimum: 1 Maximum: 200000 |
category |
Yes |
String |
Types of exported vulnerability data. Its value can be:
Minimum: 0 Maximum: 256 |
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 the user token. Minimum: 1 Maximum: 32768 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
export_headers |
No |
Array<Array<String>> |
Table heading list of exported vulnerability data Array Length: 1 - 10000 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
task_id |
String |
Task ID. Minimum: 1 Maximum: 64 |
Example Requests
None
Example Responses
Status code: 200
Response result of exported requests
{ "task_id" : "2b31ed520xxxxxxebedb6e57xxxxxxxx" }
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 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 |
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 ExportVulsSolution { 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(); ExportVulsRequest request = new ExportVulsRequest(); request.withEnterpriseProjectId("<enterprise_project_id>"); request.withType("<type>"); request.withVulId("<vul_id>"); request.withVulName("<vul_name>"); request.withHostId("<host_id>"); request.withLimit(<limit>); request.withOffset(<offset>); request.withRepairPriority("<repair_priority>"); request.withHandleStatus("<handle_status>"); request.withCveId("<cve_id>"); request.withLabelList("<label_list>"); request.withStatus("<status>"); request.withAssetValue("<asset_value>"); request.withGroupName("<group_name>"); request.withExportSize(<export_size>); request.withCategory("<category>"); ExportVulRequestBody body = new ExportVulRequestBody(); request.withBody(body); try { ExportVulsResponse response = client.exportVuls(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 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 |
# 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 = ExportVulsRequest() request.enterprise_project_id = "<enterprise_project_id>" request.type = "<type>" request.vul_id = "<vul_id>" request.vul_name = "<vul_name>" request.host_id = "<host_id>" request.limit = <limit> request.offset = <offset> request.repair_priority = "<repair_priority>" request.handle_status = "<handle_status>" request.cve_id = "<cve_id>" request.label_list = "<label_list>" request.status = "<status>" request.asset_value = "<asset_value>" request.group_name = "<group_name>" request.export_size = <export_size> request.category = "<category>" request.body = ExportVulRequestBody( ) response = client.export_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 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 |
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.ExportVulsRequest{} enterpriseProjectIdRequest:= "<enterprise_project_id>" request.EnterpriseProjectId = &enterpriseProjectIdRequest typeRequest:= "<type>" request.Type = &typeRequest vulIdRequest:= "<vul_id>" request.VulId = &vulIdRequest vulNameRequest:= "<vul_name>" request.VulName = &vulNameRequest hostIdRequest:= "<host_id>" request.HostId = &hostIdRequest limitRequest:= int32(<limit>) request.Limit = &limitRequest offsetRequest:= int32(<offset>) request.Offset = &offsetRequest repairPriorityRequest:= "<repair_priority>" request.RepairPriority = &repairPriorityRequest handleStatusRequest:= "<handle_status>" request.HandleStatus = &handleStatusRequest cveIdRequest:= "<cve_id>" request.CveId = &cveIdRequest labelListRequest:= "<label_list>" request.LabelList = &labelListRequest statusRequest:= "<status>" request.Status = &statusRequest assetValueRequest:= "<asset_value>" request.AssetValue = &assetValueRequest groupNameRequest:= "<group_name>" request.GroupName = &groupNameRequest request.ExportSize = int32(<export_size>) request.Category = "<category>" request.Body = &model.ExportVulRequestBody{ } response, err := client.ExportVuls(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 |
Response result of exported requests |
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