Help Center/ Host Security Service/ API Reference/ API Description/ Baseline Checks/ Exporting Baseline Check Reports from the Backend as Excel Files
Updated on 2025-09-30 GMT+08:00

Exporting Baseline Check Reports from the Backend as Excel Files

Function

This API is used to export baseline check reports from the backend as Excel files.

Calling Method

For details, see Calling APIs.

URI

POST /v5/{project_id}/baseline/export

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID.

Constraints

N/A

Range

Length: 1 to 256 characters

Default Value

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Definition

Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID.

To query assets in all enterprise projects, set this parameter to all_granted_eps.

Constraints

You need to set this parameter only after the enterprise project function is enabled.

Range

Length: 1 to 256 characters

Default Value

0: default enterprise project.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token.

Constraints

N/A

Range

Length: 1 to 32768 characters

Default Value

N/A

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

category

No

String

Definition

Export type.

Constraints

N/A

Range

  • risk-config: baseline configuration check

  • password-complexity: password complexity check

  • weak-password: weak password check

Default Value

risk-config

export_size

No

Integer

Definition

Number of exported data records.

Constraints

N/A

Range

1 to 200000

Default Value

100000

group_id

No

String

Definition

Policy group ID

Constraints

N/A

Range

Length: 0 to 128 characters

Default Value

N/A

check_name

No

String

Definition

Configuration check baseline name, for example, SSH, CentOS 7, or Windows.

Constraints

N/A

Range

Length: 0 to 256 characters

Default Value

N/A

standard

No

String

Definition

Standard type.

Constraints

N/A

Range

  • cn_standard: DJCP MLPS compliance standard

  • hw_standard: Cloud security practice standard

cis_standard: general security standard

Default Value

N/A

scan_result

No

String

Definition

Check result.

Constraints

N/A

Range

  • pass: The check is passed.

  • failed: The check is not passed. (This value has been discarded.)

  • unhandled: The check is not passed.

Default Value

N/A

severity

No

String

Definition

Risk level.

Constraints

N/A

Range

  • Security

  • Low

  • Medium

  • High

Default Value

N/A

host_id

No

String

Definition

Server ID. If this parameter is not specified, all the servers of the user are queried.

Constraints

N/A

Range

Length: 0 to 64 characters

Default Value

N/A

limit

No

Integer

Number of records displayed on each page.

offset

No

Integer

Offset, which specifies the start position of the record to be returned.

export_headers

Yes

Array<Array<String>>

List of table headers for exporting configuration detection data

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

task_id

String

Definition

Task ID.

Range

N/A

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

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

SDK Sample Code

The SDK sample code is as follows.

 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)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.