文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 基线管理/ 从后端导出基线检测报告,生成Excel文件 - ExportBaselineSecurityCheckReport
更新时间:2025-12-26 GMT+08:00
分享

从后端导出基线检测报告,生成Excel文件 - ExportBaselineSecurityCheckReport

功能介绍

从后端导出基线检测报告,生成Excel文件。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

POST /v5/{project_id}/baseline/export

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID

约束限制:

不涉及

取值范围:

字符长度1-256位。

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID

如需查询所有企业项目下的资产请传参“all_granted_eps”。

约束限制:

开通企业项目功能后才需要配置企业项目ID参数。

取值范围:

字符长度1-256位

默认取值:

0,表示默认企业项目(default)。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token

约束限制:

不涉及

取值范围:

字符长度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<Array<String>>

导出配置检测数据的表头信息列表

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

取值范围

不涉及

请求示例

响应示例

状态码:200

请求已成功

{
  "task_id" : "f2bead8f-xxxx-xxxx-xxxx-911c461dxxxx"
}

SDK代码示例

SDK代码示例如下。

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


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("<YOUR REGION>"))
                .build();
        ExportBaselineSecurityCheckReportRequest request = new ExportBaselineSecurityCheckReportRequest();
        ExportBaselineRequestBody body = new ExportBaselineRequestBody();
        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());
        }
    }
}
 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
# 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 = ExportBaselineSecurityCheckReportRequest()
        request.body = ExportBaselineRequestBody(
        )
        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)
 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
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.ExportBaselineSecurityCheckReportRequest{}
	request.Body = &model.ExportBaselineRequestBody{
	}
	response, err := client.ExportBaselineSecurityCheckReport(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档