# 从后端导出基线检测报告，生成Excel文件 - ExportBaselineSecurityCheckReport #### 功能介绍 从后端导出基线检测报告，生成Excel文件。 #### 调用方法 请参见[如何调用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}/baseline/export 表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参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | category | 否 | String | **参数解释**： 导出类型 **约束限制**： 不涉及 **取值范围**： - risk-config : 基线配置检测 - password-complexity : 口令复杂度检测 - weak-password : 弱口令检测 **默认取值**： risk-config | | export_size | 否 | Integer | **参数解释** 导出数据条数 **约束限制** 不涉及 **取值范围** 取值 1 - 200000 **默认取值** 100000 | | group_id | 否 | String | **参数解释**： 策略组id **约束限制**： 不涉及 **取值范围**： 字符长度0-128位 **默认取值**: 不涉及 | | check_name | 否 | String | **参数解释**： 配置检查（基线）的名称，例如SSH、CentOS 7、Windows **约束限制**： 不涉及 **取值范围**： 字符长度0-256位 **默认取值**: 不涉及 | | standard | 否 | String | **参数解释**： 标准类型 **约束限制**： 不涉及 **取值范围**： - cn_standard ： 等保合规标准 - hw_standard ： 云安全实践标准 - cis_standard ： 通用安全标准 **默认取值**: 不涉及 | | scan_result | 否 | String | **参数解释**： 检查结果 **约束限制**： 不涉及 **取值范围** - pass : 检查通过 - failed : 检查未通过(已废弃) - unhandled: 未通过 **默认取值** 不涉及 | | severity | 否 | String | **参数解释**： 风险等级 **约束限制**： 不涉及 **取值范围** - Security: 无风险 - Low : 低危 - Medium : 中危 - High: 高危 **默认取值** 不涉及 | | host_id | 否 | String | **参数解释**： 主机ID，不赋值时，查租户所有主机 **约束限制**： 不涉及 **取值范围**： 字符长度0-64位 **默认取值**: 不涉及 | | limit | 否 | Integer | 每页显示个数 | | offset | 否 | Integer | 偏移量：指定返回记录的开始位置 | | export_headers | 是 | Array\\> | 导出配置检测数据的表头信息列表 | | tag | 否 | String | **参数解释** 基线检查项的类型 **约束限制** 不涉及 **取值范围** 字符长度0-256位 **默认取值** 不涉及 | | check_type | 否 | String | **参数解释** 配置检查（基线）的名称，例如SSH、CentOS 7、Windows **约束限制** 不涉及 **取值范围** 字符长度0-256位 **默认取值** 不涉及 | | statistics_scan_result | 否 | String | **参数解释** 统计结果类型，包含如下： **约束限制** 不涉及 **取值范围** - pass : 已通过，表示查看主机全部通过的检查项 - failed : 未通过，表示查看主机全部未通过 \& 全部未处理的检查项 - processed : 已处理，表示查看主机存在未通过 \& 未通过主机已全部处理(忽略、加白)的检查项 **默认取值** 不涉及 | | check_rule_name | 否 | String | **参数解释** 检查项（检查规则）名称，支持模糊匹配 **约束限制** 不涉及 **取值范围** 字符长度0-2048位 **默认取值** 不涉及 | | cluster_id | 否 | String | **参数解释** 集群ID **约束限制** 不涉及 **取值范围** 字符长度0-64位 **默认取值** 不涉及 | #### 响应参数 **状态码：200** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | task_id | String | **参数解释**： 任务ID **取值范围**： 不涉及 | #### 请求示例 导出基线报告 ``` POST /v5/{project_id}/baseline/export { "offset" : 0, "category" : "risk-config", "export_size" : 100000, "export_headers" : [ [ "tag", "检查类型" ], [ "host_id", "服务器ID" ], [ "host_name", "服务器名称" ], [ "host_public_ip", "弹性公网IP地址" ], [ "host_private_ip", "私有IP地址" ], [ "check_name", "基线名称" ], [ "check_type", "基线类型" ], [ "standard", "标准类型" ], [ "executable_file_path", "路径" ], [ "check_rule_name", "检查项" ], [ "severity", "风险等级" ], [ "status", "状态" ], [ "check_rule_desc", "规则描述" ], [ "audit", "审计描述" ], [ "remediation", "修改建议" ], [ "check_info_list", "检测用例信息" ], [ "formatted_first_scan_time", "最新检测时间" ] ], "scan_result" : "unhandled" } ``` #### 响应示例 **状态码：200** 请求已成功 ``` { "task_id" : "f2bead8f-xxxx-xxxx-xxxx-911c461dxxxx" } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 导出基线报告 ``` 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 ExportBaselineSecurityCheckReportSolution { 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(); ExportBaselineSecurityCheckReportRequest request = new ExportBaselineSecurityCheckReportRequest(); ExportBaselineRequestBody body = new ExportBaselineRequestBody(); List listExportHeadersExportHeaders = new ArrayList<>(); listExportHeadersExportHeaders.add("formatted_first_scan_time"); listExportHeadersExportHeaders.add("最新检测时间"); List listExportHeadersExportHeaders1 = new ArrayList<>(); listExportHeadersExportHeaders1.add("check_info_list"); listExportHeadersExportHeaders1.add("检测用例信息"); List listExportHeadersExportHeaders2 = new ArrayList<>(); listExportHeadersExportHeaders2.add("remediation"); listExportHeadersExportHeaders2.add("修改建议"); List listExportHeadersExportHeaders3 = new ArrayList<>(); listExportHeadersExportHeaders3.add("audit"); listExportHeadersExportHeaders3.add("审计描述"); List listExportHeadersExportHeaders4 = new ArrayList<>(); listExportHeadersExportHeaders4.add("check_rule_desc"); listExportHeadersExportHeaders4.add("规则描述"); List listExportHeadersExportHeaders5 = new ArrayList<>(); listExportHeadersExportHeaders5.add("status"); listExportHeadersExportHeaders5.add("状态"); List listExportHeadersExportHeaders6 = new ArrayList<>(); listExportHeadersExportHeaders6.add("severity"); listExportHeadersExportHeaders6.add("风险等级"); List listExportHeadersExportHeaders7 = new ArrayList<>(); listExportHeadersExportHeaders7.add("check_rule_name"); listExportHeadersExportHeaders7.add("检查项"); List listExportHeadersExportHeaders8 = new ArrayList<>(); listExportHeadersExportHeaders8.add("executable_file_path"); listExportHeadersExportHeaders8.add("路径"); List listExportHeadersExportHeaders9 = new ArrayList<>(); listExportHeadersExportHeaders9.add("standard"); listExportHeadersExportHeaders9.add("标准类型"); List listExportHeadersExportHeaders10 = new ArrayList<>(); listExportHeadersExportHeaders10.add("check_type"); listExportHeadersExportHeaders10.add("基线类型"); List listExportHeadersExportHeaders11 = new ArrayList<>(); listExportHeadersExportHeaders11.add("check_name"); listExportHeadersExportHeaders11.add("基线名称"); List listExportHeadersExportHeaders12 = new ArrayList<>(); listExportHeadersExportHeaders12.add("host_private_ip"); listExportHeadersExportHeaders12.add("私有IP地址"); List listExportHeadersExportHeaders13 = new ArrayList<>(); listExportHeadersExportHeaders13.add("host_public_ip"); listExportHeadersExportHeaders13.add("弹性公网IP地址"); List listExportHeadersExportHeaders14 = new ArrayList<>(); listExportHeadersExportHeaders14.add("host_name"); listExportHeadersExportHeaders14.add("服务器名称"); List listExportHeadersExportHeaders15 = new ArrayList<>(); listExportHeadersExportHeaders15.add("host_id"); listExportHeadersExportHeaders15.add("服务器ID"); List listExportHeadersExportHeaders16 = new ArrayList<>(); listExportHeadersExportHeaders16.add("tag"); listExportHeadersExportHeaders16.add("检查类型"); List> listbodyExportHeaders = new ArrayList<>(); listbodyExportHeaders.add(listExportHeadersExportHeaders); listbodyExportHeaders.add(listExportHeadersExportHeaders1); listbodyExportHeaders.add(listExportHeadersExportHeaders2); listbodyExportHeaders.add(listExportHeadersExportHeaders3); listbodyExportHeaders.add(listExportHeadersExportHeaders4); listbodyExportHeaders.add(listExportHeadersExportHeaders5); listbodyExportHeaders.add(listExportHeadersExportHeaders6); listbodyExportHeaders.add(listExportHeadersExportHeaders7); listbodyExportHeaders.add(listExportHeadersExportHeaders8); listbodyExportHeaders.add(listExportHeadersExportHeaders9); listbodyExportHeaders.add(listExportHeadersExportHeaders10); listbodyExportHeaders.add(listExportHeadersExportHeaders11); listbodyExportHeaders.add(listExportHeadersExportHeaders12); listbodyExportHeaders.add(listExportHeadersExportHeaders13); listbodyExportHeaders.add(listExportHeadersExportHeaders14); listbodyExportHeaders.add(listExportHeadersExportHeaders15); listbodyExportHeaders.add(listExportHeadersExportHeaders16); body.withExportHeaders(listbodyExportHeaders); body.withOffset(0); body.withScanResult("unhandled"); body.withExportSize(100000); body.withCategory("risk-config"); request.withBody(body); try { ExportBaselineSecurityCheckReportResponse response = client.exportBaselineSecurityCheckReport(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] 导出基线报告 ``` # 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 = ExportBaselineSecurityCheckReportRequest() listExportHeadersExportHeaders = [ "formatted_first_scan_time", "最新检测时间" ] listExportHeadersExportHeaders1 = [ "check_info_list", "检测用例信息" ] listExportHeadersExportHeaders2 = [ "remediation", "修改建议" ] listExportHeadersExportHeaders3 = [ "audit", "审计描述" ] listExportHeadersExportHeaders4 = [ "check_rule_desc", "规则描述" ] listExportHeadersExportHeaders5 = [ "status", "状态" ] listExportHeadersExportHeaders6 = [ "severity", "风险等级" ] listExportHeadersExportHeaders7 = [ "check_rule_name", "检查项" ] listExportHeadersExportHeaders8 = [ "executable_file_path", "路径" ] listExportHeadersExportHeaders9 = [ "standard", "标准类型" ] listExportHeadersExportHeaders10 = [ "check_type", "基线类型" ] listExportHeadersExportHeaders11 = [ "check_name", "基线名称" ] listExportHeadersExportHeaders12 = [ "host_private_ip", "私有IP地址" ] listExportHeadersExportHeaders13 = [ "host_public_ip", "弹性公网IP地址" ] listExportHeadersExportHeaders14 = [ "host_name", "服务器名称" ] listExportHeadersExportHeaders15 = [ "host_id", "服务器ID" ] listExportHeadersExportHeaders16 = [ "tag", "检查类型" ] listExportHeadersbody = [ listExportHeadersExportHeaders, listExportHeadersExportHeaders1, listExportHeadersExportHeaders2, listExportHeadersExportHeaders3, listExportHeadersExportHeaders4, listExportHeadersExportHeaders5, listExportHeadersExportHeaders6, listExportHeadersExportHeaders7, listExportHeadersExportHeaders8, listExportHeadersExportHeaders9, listExportHeadersExportHeaders10, listExportHeadersExportHeaders11, listExportHeadersExportHeaders12, listExportHeadersExportHeaders13, listExportHeadersExportHeaders14, listExportHeadersExportHeaders15, listExportHeadersExportHeaders16 ] request.body = ExportBaselineRequestBody( export_headers=listExportHeadersbody, offset=0, scan_result="unhandled", export_size=100000, category="risk-config" ) response = client.export_baseline_security_check_report(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] 导出基线报告 ``` 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.ExportBaselineSecurityCheckReportRequest{} var listExportHeadersExportHeaders = []string{ "formatted_first_scan_time", "最新检测时间", } var listExportHeadersExportHeaders1 = []string{ "check_info_list", "检测用例信息", } var listExportHeadersExportHeaders2 = []string{ "remediation", "修改建议", } var listExportHeadersExportHeaders3 = []string{ "audit", "审计描述", } var listExportHeadersExportHeaders4 = []string{ "check_rule_desc", "规则描述", } var listExportHeadersExportHeaders5 = []string{ "status", "状态", } var listExportHeadersExportHeaders6 = []string{ "severity", "风险等级", } var listExportHeadersExportHeaders7 = []string{ "check_rule_name", "检查项", } var listExportHeadersExportHeaders8 = []string{ "executable_file_path", "路径", } var listExportHeadersExportHeaders9 = []string{ "standard", "标准类型", } var listExportHeadersExportHeaders10 = []string{ "check_type", "基线类型", } var listExportHeadersExportHeaders11 = []string{ "check_name", "基线名称", } var listExportHeadersExportHeaders12 = []string{ "host_private_ip", "私有IP地址", } var listExportHeadersExportHeaders13 = []string{ "host_public_ip", "弹性公网IP地址", } var listExportHeadersExportHeaders14 = []string{ "host_name", "服务器名称", } var listExportHeadersExportHeaders15 = []string{ "host_id", "服务器ID", } var listExportHeadersExportHeaders16 = []string{ "tag", "检查类型", } var listExportHeadersbody = [][]string{ listExportHeadersExportHeaders, listExportHeadersExportHeaders1, listExportHeadersExportHeaders2, listExportHeadersExportHeaders3, listExportHeadersExportHeaders4, listExportHeadersExportHeaders5, listExportHeadersExportHeaders6, listExportHeadersExportHeaders7, listExportHeadersExportHeaders8, listExportHeadersExportHeaders9, listExportHeadersExportHeaders10, listExportHeadersExportHeaders11, listExportHeadersExportHeaders12, listExportHeadersExportHeaders13, listExportHeadersExportHeaders14, listExportHeadersExportHeaders15, listExportHeadersExportHeaders16, } offsetExportBaselineRequestBody:= int32(0) scanResultExportBaselineRequestBody:= "unhandled" exportSizeExportBaselineRequestBody:= int32(100000) categoryExportBaselineRequestBody:= "risk-config" request.Body = &model.ExportBaselineRequestBody{ ExportHeaders: listExportHeadersbody, Offset: &offsetExportBaselineRequestBody, ScanResult: &scanResultExportBaselineRequestBody, ExportSize: &exportSizeExportBaselineRequestBody, Category: &categoryExportBaselineRequestBody, } response, err := client.ExportBaselineSecurityCheckReport(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=ExportBaselineSecurityCheckReport&version=v5)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求已成功 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-hss2.0/ErrorCode.html)。