Exporting Vulnerabilities
Function
This API is used to export vulnerability details.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/workspaces/{workspace_id}/soc/vulnerability/export
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Definition Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID Constraints N/A Range N/A Default Value N/A |
|
workspace_id |
Yes |
String |
Definition Workspace ID. Constraints N/A Range N/A Default Value N/A |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
data_object_filters_form |
No |
Search criteria. |
|
|
title |
No |
Array of strings |
Exported fields. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
limit |
No |
Integer |
Page size. |
|
offset |
No |
Integer |
Offset. |
|
sort_by |
No |
String |
Sorting field: create_time | update_time |
|
order |
No |
String |
Sorting order. Options: DESC and ASC. |
|
from_date |
No |
String |
Search start time, for example, 2023-02-20T00:00:00.000Z. |
|
to_date |
No |
String |
Search end time, for example, 2023-02-27T23:59:59.999Z. |
|
condition |
No |
condition object |
Search condition expression. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
conditions |
No |
Array of conditions objects |
Expression list. |
|
logics |
No |
Array of strings |
Expression name list. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
- |
File |
Exported vulnerability list. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
code |
String |
Definition Error code. Range N/A |
|
message |
String |
Definition Error description. Range N/A |
Example Requests
https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}/soc/vulnerability/export
{
"data_object_filters_form" : {
"limit" : 10000,
"offset" : 0,
"from_date" : "2025-12-09T14:14:16.257Z+0800",
"to_date" : "2025-12-09T14:14:16.257Z+0800",
"condition" : {
"conditions" : [ {
"name" : "vulnerability.type",
"data" : [ "vulnerability.type", "=", "0" ]
} ],
"logics" : [ "vulnerability.type" ]
}
},
"title" : [ "vul_name", "vulnerability.level", "id", "vulnerability.related", "resource", "environment", "data_source", "workspace_id", "arrive_time", "description", "create_time", "count", "batch_number", "first_observed_time", "region_id", "domain_id", "version", "vulnerability" ]
}
Example Responses
Status code: 200
Exported vulnerability list.
"vulnerability_export_20260113162514.xlsx"
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 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 |
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.secmaster.v1.region.SecMasterRegion; import com.huaweicloud.sdk.secmaster.v1.*; import com.huaweicloud.sdk.secmaster.v1.model.*; import java.util.List; import java.util.ArrayList; public class ExportVulnerabilitiesSolution { 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); SecMasterClient client = SecMasterClient.newBuilder() .withCredential(auth) .withRegion(SecMasterRegion.valueOf("<YOUR REGION>")) .build(); ExportVulnerabilitiesRequest request = new ExportVulnerabilitiesRequest(); request.withWorkspaceId("{workspace_id}"); ExportVulnerabilitiesRequestBody body = new ExportVulnerabilitiesRequestBody(); List<String> listbodyTitle = new ArrayList<>(); listbodyTitle.add("vul_name"); listbodyTitle.add("vulnerability.level"); listbodyTitle.add("id"); listbodyTitle.add("vulnerability.related"); listbodyTitle.add("resource"); listbodyTitle.add("environment"); listbodyTitle.add("data_source"); listbodyTitle.add("workspace_id"); listbodyTitle.add("arrive_time"); listbodyTitle.add("description"); listbodyTitle.add("create_time"); listbodyTitle.add("count"); listbodyTitle.add("batch_number"); listbodyTitle.add("first_observed_time"); listbodyTitle.add("region_id"); listbodyTitle.add("domain_id"); listbodyTitle.add("version"); listbodyTitle.add("vulnerability"); List<String> listConditionLogics = new ArrayList<>(); listConditionLogics.add("vulnerability.type"); List<String> listConditionsData = new ArrayList<>(); listConditionsData.add("vulnerability.type"); listConditionsData.add("="); listConditionsData.add("0"); List<VulnerabilityDataObjectSearchConditionConditions> listConditionConditions = new ArrayList<>(); listConditionConditions.add( new VulnerabilityDataObjectSearchConditionConditions() .withName("vulnerability.type") .withData(listConditionsData) ); VulnerabilityDataObjectSearchCondition conditionDataObjectFiltersForm = new VulnerabilityDataObjectSearchCondition(); conditionDataObjectFiltersForm.withConditions(listConditionConditions) .withLogics(listConditionLogics); VulnerabilityDataObjectSearch dataObjectFiltersFormbody = new VulnerabilityDataObjectSearch(); dataObjectFiltersFormbody.withLimit(10000) .withOffset(0) .withFromDate("2025-12-09T14:14:16.257Z+0800") .withToDate("2025-12-09T14:14:16.257Z+0800") .withCondition(conditionDataObjectFiltersForm); body.withTitle(listbodyTitle); body.withDataObjectFiltersForm(dataObjectFiltersFormbody); request.withBody(body); try { ExportVulnerabilitiesResponse response = client.exportVulnerabilities(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 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdksecmaster.v1.region.secmaster_region import SecMasterRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdksecmaster.v1 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 = SecMasterClient.new_builder() \ .with_credentials(credentials) \ .with_region(SecMasterRegion.value_of("<YOUR REGION>")) \ .build() try: request = ExportVulnerabilitiesRequest() request.workspace_id = "{workspace_id}" listTitlebody = [ "vul_name", "vulnerability.level", "id", "vulnerability.related", "resource", "environment", "data_source", "workspace_id", "arrive_time", "description", "create_time", "count", "batch_number", "first_observed_time", "region_id", "domain_id", "version", "vulnerability" ] listLogicsCondition = [ "vulnerability.type" ] listDataConditions = [ "vulnerability.type", "=", "0" ] listConditionsCondition = [ VulnerabilityDataObjectSearchConditionConditions( name="vulnerability.type", data=listDataConditions ) ] conditionDataObjectFiltersForm = VulnerabilityDataObjectSearchCondition( conditions=listConditionsCondition, logics=listLogicsCondition ) dataObjectFiltersFormbody = VulnerabilityDataObjectSearch( limit=10000, offset=0, from_date="2025-12-09T14:14:16.257Z+0800", to_date="2025-12-09T14:14:16.257Z+0800", condition=conditionDataObjectFiltersForm ) request.body = ExportVulnerabilitiesRequestBody( title=listTitlebody, data_object_filters_form=dataObjectFiltersFormbody ) response = client.export_vulnerabilities(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 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" secmaster "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1/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 := secmaster.NewSecMasterClient( secmaster.SecMasterClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ExportVulnerabilitiesRequest{} request.WorkspaceId = "{workspace_id}" var listTitlebody = []string{ "vul_name", "vulnerability.level", "id", "vulnerability.related", "resource", "environment", "data_source", "workspace_id", "arrive_time", "description", "create_time", "count", "batch_number", "first_observed_time", "region_id", "domain_id", "version", "vulnerability", } var listLogicsCondition = []string{ "vulnerability.type", } var listDataConditions = []string{ "vulnerability.type", "=", "0", } nameConditions:= "vulnerability.type" var listConditionsCondition = []model.VulnerabilityDataObjectSearchConditionConditions{ { Name: &nameConditions, Data: &listDataConditions, }, } conditionDataObjectFiltersForm := &model.VulnerabilityDataObjectSearchCondition{ Conditions: &listConditionsCondition, Logics: &listLogicsCondition, } limitDataObjectFiltersForm:= int32(10000) offsetDataObjectFiltersForm:= int32(0) fromDateDataObjectFiltersForm:= "2025-12-09T14:14:16.257Z+0800" toDateDataObjectFiltersForm:= "2025-12-09T14:14:16.257Z+0800" dataObjectFiltersFormbody := &model.VulnerabilityDataObjectSearch{ Limit: &limitDataObjectFiltersForm, Offset: &offsetDataObjectFiltersForm, FromDate: &fromDateDataObjectFiltersForm, ToDate: &toDateDataObjectFiltersForm, Condition: conditionDataObjectFiltersForm, } request.Body = &model.ExportVulnerabilitiesRequestBody{ Title: &listTitlebody, DataObjectFiltersForm: dataObjectFiltersFormbody, } response, err := client.ExportVulnerabilities(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 |
Exported vulnerability list. |
|
400 |
Body of the response for failed requests for exporting vulnerabilities. |
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