# 导出漏洞及漏洞影响的主机的相关信息 - ExportVuls #### 功能介绍 导出漏洞及漏洞影响的主机的相关信息。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-hss2.0/hss_02_0007.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-hss2.0/hss_02_0022.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI POST /v5/{project_id}/vul/export 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | enterprise_project_id | 否 | String | 主机所属的企业项目ID。 开通企业项目功能后才需要配置企业项目。 企业项目ID默认取值为"0"，表示默认企业项目。如果需要查询所有企业项目下的主机，请传参"all_granted_eps"。如果您只有某个企业项目的权限，则需要传递该企业项目ID，查询该企业项目下的主机，否则会因权限不足而报错。 | | 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，导出单台主机漏洞时会用到 | | export_size | 是 | Integer | 导出数据条数 | | category | 是 | String | 导出漏洞数据类别: - vul ：漏洞 - host: 主机漏洞 | | 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 | 漏洞状态，包含如下： - vul_status_unfix：未处理 - vul_status_ignored：已忽略 - vul_status_verified：验证中 - vul_status_fixing：修复中 - vul_status_fixed：修复成功 - vul_status_reboot：修复成功待重启 - vul_status_failed：修复失败 - vul_status_fix_after_reboot：请重启主机再次修复 | | asset_value | 否 | String | 资产重要性 important common test | | group_name | 否 | String | 服务器组名称 | | node_type | 否 | String | **参数解释**: 节点类型 **约束限制**: 不涉及 **取值范围**: - cce：cce节点 - not_cce：非cce节点 字符长度0-256位 **默认取值**: 不涉及 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） | 表4请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | export_headers | 是 | Array\\> | 导出漏洞数据的表头信息列表 | | vul_id_list | 否 | Array of strings | 指定导出的漏洞id列表 | | host_id_list | 否 | Array of strings | 指定导出的主机id列表 | #### 响应参数 **状态码：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代码示例如下。 - [Java] 导出linux漏洞，修复等级包含紧急高中低，处理状态为未处理；导出表头为企业项目，漏洞名称，漏洞ID。 ``` 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("")) .build(); ExportVulsRequest request = new ExportVulsRequest(); ExportVulRequestBody body = new ExportVulRequestBody(); List listExportHeadersExportHeaders = new ArrayList<>(); listExportHeadersExportHeaders.add("vul_id"); listExportHeadersExportHeaders.add("漏洞ID"); List listExportHeadersExportHeaders1 = new ArrayList<>(); listExportHeadersExportHeaders1.add("vul_name"); listExportHeadersExportHeaders1.add("漏洞名称"); List listExportHeadersExportHeaders2 = new ArrayList<>(); listExportHeadersExportHeaders2.add("enterprise_project_name"); listExportHeadersExportHeaders2.add("企业项目"); List> 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()); } } } ``` - [Python] 导出linux漏洞，修复等级包含紧急高中低，处理状态为未处理；导出表头为企业项目，漏洞名称，漏洞ID。 ``` # 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("")) \ .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) ``` - [Go] 导出linux漏洞，修复等级包含紧急高中低，处理状态为未处理；导出表头为企业项目，漏洞名称，漏洞ID。 ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := hss.HssClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := hss.NewHssClient(hcClient) 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](https://console.huaweicloud.com/apiexplorer/#/openapi/HSS/sdk?api=ExportVuls&version=v5)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求已成功 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-hss2.0/ErrorCode.html)。