# 创建历史处理的漏洞导出任务 - ExportHandledVulnerabilities #### 功能介绍 创建历史处理的漏洞导出任务。 #### 调用方法 请参见[如何调用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}/vulnerability/history/export-task 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**: 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-hss2.0/hss_02_0024.html)。 **约束限制**: 不涉及 **取值范围**: 字符长度1-256位 **默认取值**: 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | enterprise_project_id | 否 | String | **参数解释**: 企业项目ID，用于过滤不同企业项目下的资产。获取方式请参见[获取企业项目ID](https://support.huaweicloud.com/api-hss2.0/hss_02_0027.html)。 如需查询所有企业项目下的资产请传参"all_granted_eps"。 **约束限制**: 开通企业项目功能后才需要配置企业项目ID参数。 **取值范围**: 字符长度1-256位 **默认取值**: 0，表示默认企业项目（default）。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**: 用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见[获取用户Token](https://support.huaweicloud.com/api-hss2.0/hss_02_0009.html)。 **约束限制**: 不涉及 **取值范围**: 字符长度1-32768位 **默认取值**: 不涉及 | 表4请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | vul_name | 否 | String | 漏洞名称 | | repair_priority | 否 | String | 漏洞修复优先级,包含如下 - Critical 紧急 - High 高 - Medium 中 - Low 低 枚举值： - **Critical** - **High** - **Medium** - **Low** | | host_name | 否 | String | 主机名称 | | host_ip | 否 | String | 主机ip | | is_affect_business | 否 | Boolean | 是否影响业务 | | 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 : 请重启主机再次修复 枚举值： - **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：测试 枚举值： - **important** - **common** - **test** | | label | 否 | String | 漏洞标签 | | type | 否 | String | 漏洞类型，包含如下： -linux_vul : linux漏洞 -windows_vul : windows漏洞 -web_cms : Web-CMS漏洞 -app_vul : 应用漏洞 -urgent_vul : 应急漏洞 枚举值： - **linux_vul** - **windows_vul** - **web_cms** - **app_vul** - **urgent_vul** | | group_name | 否 | String | 服务器组名称 | | handle_cycle | 否 | String | 需要查询的漏洞处置周期： - today：查询今日处理的数据 - all：查询所有已处理数据 枚举值： - **today** - **all** | | specific_vuls | 否 | Array of [specific_vuls] objects | 指定要导出的漏洞数据 | | export_size | 否 | Integer | 导出数据条数 | | export_headers | 是 | Array\\> | 导出漏洞数据的表头信息列表 | 表5specific_vuls | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | host_id | 否 | String | 主机id | | vul_id | 否 | String | 漏洞id | #### 响应参数 **状态码：200** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | task_id | String | 任务ID | #### 请求示例 导出project_id为2b31ed520xxxxxxebedb6e57xxxxxxxx的所有历史已处理Linux漏洞，导出的excel数据有"漏洞名称"一列 ``` POST https://{endpoint}/v5/2b31ed520xxxxxxebedb6e57xxxxxxxx/vulnerability/history/export-task?enterprise_project_id=all_granted_eps { "type" : "linux_vul", "handle_cycle" : "all", "export_headers" : [ [ "vul_name", "漏洞名称" ] ] } ``` #### 响应示例 **状态码：200** 请求已成功 ``` { "task_id" : "xxx" } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 导出project_id为2b31ed520xxxxxxebedb6e57xxxxxxxx的所有历史已处理Linux漏洞，导出的excel数据有"漏洞名称"一列 ``` 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 ExportHandledVulnerabilitiesSolution { 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(); ExportHandledVulnerabilitiesRequest request = new ExportHandledVulnerabilitiesRequest(); ExportHandledVulnerabilitiesRequestBody body = new ExportHandledVulnerabilitiesRequestBody(); List listExportHeadersExportHeaders = new ArrayList<>(); listExportHeadersExportHeaders.add("vul_name"); listExportHeadersExportHeaders.add("漏洞名称"); List> listbodyExportHeaders = new ArrayList<>(); listbodyExportHeaders.add(listExportHeadersExportHeaders); body.withExportHeaders(listbodyExportHeaders); body.withHandleCycle(ExportHandledVulnerabilitiesRequestBody.ExportHandledVulnerabilitiesRequestBody.fromValue("all")); body.withType(ExportHandledVulnerabilitiesRequestBody.ExportHandledVulnerabilitiesRequestBody.fromValue("linux_vul")); request.withBody(body); try { ExportHandledVulnerabilitiesResponse response = client.exportHandledVulnerabilities(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] 导出project_id为2b31ed520xxxxxxebedb6e57xxxxxxxx的所有历史已处理Linux漏洞，导出的excel数据有"漏洞名称"一列 ``` # 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 = ExportHandledVulnerabilitiesRequest() listExportHeadersExportHeaders = [ "vul_name", "漏洞名称" ] listExportHeadersbody = [ listExportHeadersExportHeaders ] request.body = ExportHandledVulnerabilitiesRequestBody( export_headers=listExportHeadersbody, handle_cycle="all", type="linux_vul" ) response = client.export_handled_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) ``` - [Go] 导出project_id为2b31ed520xxxxxxebedb6e57xxxxxxxx的所有历史已处理Linux漏洞，导出的excel数据有"漏洞名称"一列 ``` 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.ExportHandledVulnerabilitiesRequest{} var listExportHeadersExportHeaders = []string{ "vul_name", "漏洞名称", } var listExportHeadersbody = [][]string{ listExportHeadersExportHeaders, } handleCycleExportHandledVulnerabilitiesRequestBody:= model.GetExportHandledVulnerabilitiesRequestBodyHandleCycleEnum().ALL typeExportHandledVulnerabilitiesRequestBody:= model.GetExportHandledVulnerabilitiesRequestBodyTypeEnum().LINUX_VUL request.Body = &model.ExportHandledVulnerabilitiesRequestBody{ ExportHeaders: listExportHeadersbody, HandleCycle: &handleCycleExportHandledVulnerabilitiesRequestBody, Type: &typeExportHandledVulnerabilitiesRequestBody, } response, err := client.ExportHandledVulnerabilities(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=ExportHandledVulnerabilities&version=v5)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求已成功 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-hss2.0/ErrorCode.html)。