Querying the Result List of Server Security Configuration Check

Function

This API is used to query the result list of a user's server security configuration check.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/baseline/risk-configs

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	User project ID Minimum: 1 Maximum: 256

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Enterprise project ID Minimum: 0 Maximum: 256
check_name	No	String	Baseline name Minimum: 0 Maximum: 256
group_id	No	String	Indicates the policy group ID. Minimum: 0 Maximum: 128
severity	No	String	Risk level. Its value can be: Security Low Medium High Minimum: 1 Maximum: 32
standard	No	String	Standard type. Its value can be: cn_standard: DJCP MLPS compliance standard hw_standard: Huawei standard qt_standard: Qingteng standard Minimum: 1 Maximum: 32
host_id	No	String	Server ID Minimum: 0 Maximum: 128
limit	No	Integer	Number of records displayed on each page. The default value is 10. Minimum: 0 Maximum: 200 Default: 10
offset	No	Integer	Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0. Minimum: 0 Maximum: 2000000 Default: 0

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
x-auth-token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. Minimum: 1 Maximum: 32768

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_num	Long	Total number of records Minimum: 0 Maximum: 2147483647
data_list	Array of SecurityCheckInfoResponseInfo objects	Server configuration check result list Array Length: 0 - 2147483647

**Table 5** SecurityCheckInfoResponseInfo
Parameter	Type	Description
severity	String	Risk level. Its value can be: Low Medium High Minimum: 1 Maximum: 32
check_name	String	Baseline name Minimum: 0 Maximum: 256
check_type	String	Baseline type Minimum: 0 Maximum: 256
standard	String	Standard type. Its value can be: cn_standard: DJCP MLPS compliance standard hw_standard: Huawei standard qt_standard: Qingteng standard Minimum: 1 Maximum: 16
check_rule_num	Integer	Number of check items Minimum: 0 Maximum: 2097152
failed_rule_num	Integer	Number of risk items Minimum: 0 Maximum: 2097152
host_num	Integer	Number of affected servers Minimum: 0 Maximum: 2097152
scan_time	Long	Last scan time Minimum: 0 Maximum: 2097152
check_type_desc	String	Baseline description Minimum: 0 Maximum: 65534

Example Requests

This API is used to query the server baseline configuration check list whose enterprise project ID is xxx. Data on the first page (the first 10 records) is returned by default.

GET https://{endpoint}/v5/{project_id}/baseline/risk-configs?enterprise_project_id=xxx

Example Responses

Status code: 200

server security configuration check result

{
  "total_num" : 1,
  "data_list" : [ {
    "check_name" : "Docker",
    "check_rule_num" : 25,
    "check_type" : "Docker",
    "check_type_desc" : "Configuring security audit of Docker's host configurations and container-running-related contents based on Docker Container Security Specifications V1_0.",
    "failed_rule_num" : 20,
    "host_num" : 0,
    "scan_time" : 1661716860935,
    "severity" : "High",
    "standard" : "hw_standard"
  } ]
}