Help Center/Host Security Service/API Reference/API Description/Baseline Management/Exporting Configuration Check Reports Based on Query Results
Updated on 2026-04-03 GMT+08:00
View PDF
Share

Exporting Configuration Check Reports Based on Query Results

Function

This API is used to export the configuration check report to an Excel file based on the query results.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v5/{project_id}/baseline/risk-config/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

The value can contain 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

The value can contain 1 to 256 characters.

Default Value

0: default enterprise project.

group_id

No

String

Definition

Unique ID of a server group.

Constraints

N/A

Range

The value can contain 1 to 64 characters.

Default Value

N/A

host_id

No

String

Definition

Unique ID of a server.

Constraints

N/A

Range

The value can contain 1 to 64 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

The value can contain 1 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 results.

Constraints

N/A

Range

  • pass: The check is passed.

  • failed: failed

Default Value

N/A

severity

No

String

Definition

Risk level.

Constraints

N/A

Range

  • Low

  • Medium

  • High

Default Value

N/A

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

The value can contain 1 to 32,768 characters.

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_num

Integer

Total number of configuration detection records

data_list

Array of ExportSecurityCheckInfoResponseInfo objects

Data list

Table 5 ExportSecurityCheckInfoResponseInfo

Parameter

Type

Description

host_id

String

Server ID

host_name

String

Server name

host_public_ip

String

Server EIP

host_private_ip

String

Server private IP address

check_type

String

Baseline type. The values for check_type and check_name are the same for Linux servers. For example, they can both be set to SSH or CentOS 7. For Windows servers, the values for check_type and check_name are different. For example, check_type can be set to Windows Server 2019 R2 or Windows Server 2016 R2.

check_name

String

Baseline name, for example, SSH, CentOS 7, and Windows.

standard

String

Baseline standards - cn_standard# DJCP compliance standards - hw_standard# Cloud security practice standards

check_rule_name

String

Check item (rule) name

executable_file_path

String

Path information of the configuration check (baseline)

severity

String

Risk level. Its value can be:

  • Low

  • Medium

  • High

scan_result

String

Version check result.

  • pass

  • failed

status

String

Status

  • safe: No action is required.

  • ignored: ignored

  • unhandled: not handled

check_rule_desc

String

Rule description

audit

String

Audit description

remediation

String

Modification suggestions

check_info_list

String

Test case information

create_time

Long

First scanning time (timestamp, in milliseconds).

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 1,
  "data_list" : [ {
    "host_id" : "xxx",
    "host_name" : "xxx",
    "host_public_ip" : "xxx",
    "host_private_ip" : "xxx",
    "check_type" : "xxx",
    "check_name" : "xxx",
    "standard" : "xxx",
    "check_rule_name" : "xxx",
    "executable_file_path" : "xxx",
    "severity" : "xxx",
    "scan_result" : "xxx",
    "status" : "xxx",
    "check_rule_desc" : "xxx",
    "audit" : "xxx",
    "remediation" : "xxx",
    "check_info_list" : "xxx",
    "create_time" : 253
  } ]
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Baseline Management