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.

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

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
tag	No	String	Definition Baseline check item type. Constraints N/A Range The value can contain 0 to 256 characters. Default Value N/A
check_type	No	String	Definition Configuration check baseline name, for example, SSH, CentOS 7, or Windows. Constraints N/A Range The value can contain 0 to 256 characters. Default Value N/A
statistics_scan_result	No	String	Definition Statistical result type. Constraints N/A Range pass: Check the server check items that passed the check. failed: Check the server check items that failed the check and remain unhandled. processed: Check the server check items that failed the check and have been handled (ignored or whitelisted). Default Value N/A
check_rule_name	No	String	Definition Check item name. Fuzzy match is supported. Constraints N/A Range The value can contain 0 to 2,048 characters. Default Value N/A
cluster_id	No	String	Definition Cluster ID. Constraints N/A Range The value can contain 0 to 64 characters. Default Value N/A

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

Status Codes

Status Code	Description
200	Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Baseline Management

Previous topic: Manually Checking for Unsafe Settings and Weak Passwords for Selected Servers in a Policy

Next topic: Inspecting Server Check Items

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot