Help Center/ Host Security Service/ API Reference/ API Description/ Vulnerability Management/ Exporting Information About Vulnerabilities and Their Affected Servers
Updated on 2024-11-19 GMT+08:00

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Enterprise user ID. To query all enterprise projects, set this parameter to all_granted_eps.

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

vul_id

No

String

Vulnerability ID.

vul_name

No

String

Vulnerability name.

host_id

No

String

Server ID, which will be used when vulnerabilities of a single server are exported.

limit

No

Integer

limit

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.

repair_priority

No

String

Fixing priority. Its value can be:

Critical

High

Medium

Low

handle_status

No

String

Handling status. It can be:

  • unhandled

  • handled

cve_id

No

String

Vulnerability ID.

label_list

No

String

Vulnerability tag.

status

No

String

Vulnerability status.

asset_value

No

String

Asset importance. Its value can be:

important

common

test

group_name

No

String

Server group name.

export_size

Yes

Integer

Number of exported data records.

category

Yes

String

Types of exported vulnerability data. Its value can be:

  • vul: vulnerability

  • host: host vulnerability

Request Parameters

Table 3 Request header 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.

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

export_headers

No

Array<Array<String>>

Table heading list of exported vulnerability data

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

task_id

String

Task ID.

Example Requests

Export Linux vulnerabilities. The fixing levels include critical, high, medium, and low, and the handling status is unhandled. Export the vulnerability data whose table header is enterprise project, vulnerability name, and vulnerability ID.

POST https://{endpoint}/v5/{project_id}/vul/export?handle_status=unhandled&repair_priority=Critical,High,Medium,Low&offset=0&category=vul&type=linux_vul&export_size=200000&enterprise_project_id=xxx

{
  "export_headers" : [ [ "enterprise_project_name", "Enterprise project" ], [ "vul_name", "Vulnerability name" ], [ "vul_id", "Vulnerability ID" ] ]
}

Example Responses

Status code: 200

Response result of exported requests

{
  "task_id" : "2b31ed520xxxxxxebedb6e57xxxxxxxx"
}

SDK Sample Code

The SDK sample code is as follows.

Export Linux vulnerabilities. The fixing levels include critical, high, medium, and low, and the handling status is unhandled. Export the vulnerability data whose table header is enterprise project, vulnerability name, and vulnerability ID.

 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
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.*;

import java.util.List;
import java.util.ArrayList;

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");
        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();
        ExportVulsRequest request = new ExportVulsRequest();
        ExportVulRequestBody body = new ExportVulRequestBody();
        List<String> listExportHeadersExportHeaders = new ArrayList<>();
        listExportHeadersExportHeaders.add("vul_id");
        listExportHeadersExportHeaders.add("Vulnerability ID");
        List<String> listExportHeadersExportHeaders1 = new ArrayList<>();
        listExportHeadersExportHeaders1.add("vul_name");
        listExportHeadersExportHeaders1.add("Vulnerability name");
        List<String> listExportHeadersExportHeaders2 = new ArrayList<>();
        listExportHeadersExportHeaders2.add("enterprise_project_name");
        listExportHeadersExportHeaders2.add("Enterprise project");
        List<List<String>> listbodyExportHeaders = new ArrayList<>();
        listbodyExportHeaders.add(listExportHeadersExportHeaders);
        listbodyExportHeaders.add(listExportHeadersExportHeaders1);
        listbodyExportHeaders.add(listExportHeadersExportHeaders2);
        body.withExportHeaders(listbodyExportHeaders);
        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());
        }
    }
}

Export Linux vulnerabilities. The fixing levels include critical, high, medium, and low, and the handling status is unhandled. Export the vulnerability data whose table header is enterprise project, vulnerability name, and vulnerability ID.

 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
# 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 = ExportVulsRequest()
        listExportHeadersExportHeaders = [
            "vul_id",
            "Vulnerability ID"
        ]
        listExportHeadersExportHeaders1 = [
            "vul_name",
            "Vulnerability name"
        ]
        listExportHeadersExportHeaders2 = [
            "enterprise_project_name",
            "Enterprise project"
        ]
        listExportHeadersbody = [
            listExportHeadersExportHeaders,
            listExportHeadersExportHeaders1,
            listExportHeadersExportHeaders2
        ]
        request.body = ExportVulRequestBody(
            export_headers=listExportHeadersbody
        )
        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)

Export Linux vulnerabilities. The fixing levels include critical, high, medium, and low, and the handling status is unhandled. Export the vulnerability data whose table header is enterprise project, vulnerability name, and vulnerability ID.

 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
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.ExportVulsRequest{}
	var listExportHeadersExportHeaders = []string{
        "vul_id",
	    "Vulnerability ID",
    }
	var listExportHeadersExportHeaders1 = []string{
        "vul_name",
	    "Vulnerability name",
    }
	var listExportHeadersExportHeaders2 = []string{
        "enterprise_project_name",
	    "Enterprise project",
    }
	var listExportHeadersbody = [][]string{
        listExportHeadersExportHeaders,
        listExportHeadersExportHeaders1,
        listExportHeadersExportHeaders2,
    }
	request.Body = &model.ExportVulRequestBody{
		ExportHeaders: &listExportHeadersbody,
	}
	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.