文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 漏洞管理/ 导出漏洞及漏洞影响的主机的相关信息
更新时间:2024-11-19 GMT+08:00

导出漏洞及漏洞影响的主机的相关信息

功能介绍

导出漏洞及漏洞影响的主机的相关信息

调用方法

请参见如何调用API

URI

POST /v5/{project_id}/vul/export

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

企业租户ID,查询所有企业项目时填写:all_granted_eps

type

String

漏洞类型,包含如下:

-linux_vul : linux漏洞

-windows_vul : windows漏洞

-web_cms : Web-CMS漏洞

-app_vul : 应用漏洞

-urgent_vul : 应急漏洞

vul_id

String

漏洞ID

vul_name

String

漏洞名称

host_id

String

主机id,导出单台主机漏洞时会用到

limit

Integer

limit

offset

Integer

偏移量:指定返回记录的开始位置,必须为数字,取值范围为大于或等于0,默认0

repair_priority

String

修复优先级

Critical 紧急

High 高

Medium 中

Low 低

handle_status

String

处置状态,包含如下:

  • unhandled :未处理

  • handled : 已处理

cve_id

String

漏洞编号

label_list

String

漏洞标签

status

String

漏洞状态

asset_value

String

资产重要性

important

common

test

group_name

String

服务器组名称

export_size

Integer

导出数据条数

category

String

导出漏洞数据类别:

  • vul :漏洞

  • host: 主机漏洞

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)

表4 请求Body参数

参数

是否必选

参数类型

描述

export_headers

Array<Array<String>>

导出漏洞数据的表头信息列表

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

task_id

String

任务ID

请求示例

导出linux漏洞,修复等级包含紧急高中低,处理状态为未处理;导出表头为企业项目,漏洞名称,漏洞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", "企业项目" ], [ "vul_name", "漏洞名称" ], [ "vul_id", "漏洞ID" ] ]
}

响应示例

状态码: 200

导出请求响应结果

{
  "task_id" : "2b31ed520xxxxxxebedb6e57xxxxxxxx"
}

SDK代码示例

SDK代码示例如下。

导出linux漏洞,修复等级包含紧急高中低,处理状态为未处理;导出表头为企业项目,漏洞名称,漏洞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("漏洞ID");
        List<String> listExportHeadersExportHeaders1 = new ArrayList<>();
        listExportHeadersExportHeaders1.add("vul_name");
        listExportHeadersExportHeaders1.add("漏洞名称");
        List<String> listExportHeadersExportHeaders2 = new ArrayList<>();
        listExportHeadersExportHeaders2.add("enterprise_project_name");
        listExportHeadersExportHeaders2.add("企业项目");
        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());
        }
    }
}

导出linux漏洞,修复等级包含紧急高中低,处理状态为未处理;导出表头为企业项目,漏洞名称,漏洞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",
            "漏洞ID"
        ]
        listExportHeadersExportHeaders1 = [
            "vul_name",
            "漏洞名称"
        ]
        listExportHeadersExportHeaders2 = [
            "enterprise_project_name",
            "企业项目"
        ]
        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)

导出linux漏洞,修复等级包含紧急高中低,处理状态为未处理;导出表头为企业项目,漏洞名称,漏洞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",
	    "漏洞ID",
    }
	var listExportHeadersExportHeaders1 = []string{
        "vul_name",
	    "漏洞名称",
    }
	var listExportHeadersExportHeaders2 = []string{
        "enterprise_project_name",
	    "企业项目",
    }
	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)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

导出请求响应结果

错误码

请参见错误码