Querying the Report of a Check Item in a Security Configuration Check

Function

This API is used to query the report of a check item in a security configuration check.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/baseline/check-rule/detail

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Enterprise project ID Minimum: 0 Maximum: 64
check_name	Yes	String	Baseline name Minimum: 0 Maximum: 255
check_type	Yes	String	Baseline type Minimum: 0 Maximum: 255
check_rule_id	Yes	String	Check item ID Minimum: 0 Maximum: 255
standard	Yes	String	Standard type. Its value can be: cn_standard: DJCP MLPS compliance standard hw_standard: Huawei standard qt_standard: Qingteng standard Minimum: 0 Maximum: 32
host_id	No	String	Host ID Minimum: 0 Maximum: 64

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
x-auth-token	Yes	String	User token, which 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: 32 Maximum: 2097152

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
description	String	Description Minimum: 0 Maximum: 2048
reference	String	Scenario Minimum: 0 Maximum: 255
audit	String	Audit description Minimum: 0 Maximum: 65534
remediation	String	Modification suggestion Minimum: 0 Maximum: 65534
check_info_list	Array of CheckRuleCheckCaseResponseInfo objects	Test cases Array Length: 0 - 2147483647

**Table 5** CheckRuleCheckCaseResponseInfo
Parameter	Type	Description
check_description	String	Test case description Minimum: 0 Maximum: 65534
current_value	String	Current result Minimum: 0 Maximum: 65534
suggest_value	String	Expected result Minimum: 0 Maximum: 65534

Example Requests

This API is used to query the report of the configuration check items whose baseline name is SSH, check item ID is 1.12, check standard is cloud security practice standard, and enterprise project ID is xxx.

GET https://{endpoint}/v5/{project_id}/baseline/check-rule/detail?standard=hw_standard&enterprise_project_id=xxx&check_name=SSH&check_type=SSH&check_rule_id=1.12

Example Responses

Status code: 200

Configuration item check report

{
  "audit" : "Run the following commands and verify that ClientAliveInterval is smaller than 300 and ClientAliveCountMax is 3 or less: \n#grep '^ClientAliveInterval' /etc/ssh/sshd_config\nClientAliveInterval 300(default is 0) \n#grep '^ClientAliveCountMax' /etc/ssh/sshd_config\nClientAliveCountMax 0(default is 3)",
  "description" : "The two options ClientAliveInterval and ClientAliveCountMax control the timeout of SSH sessions. The ClientAliveInterval parameter sets a timeout interval in seconds after which if no data has been received from the client, sshd will send a message through the encrypted channel to request a response from the client. The ClientAliveCountMax parameter sets the number of client alive messages which may be sent without sshd receiving any messages back from the client. For example, if the ClientAliveInterval is set to 15s and the ClientAliveCountMax is set to 3, unresponsive SSH clients will be disconnected after approximately 45s.",
  "reference" : "",
  "remediation" : "Edit the /etc/ssh/sshd_config file to set the parameter as follows: \nClientAliveInterval 300 \nClientAliveCountMax 0"
}