Querying the Check Result of a Security Configuration Item

Function

This API is used to query the check result of a specified security configuration item.

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/{check_name}/detail

**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
check_name	Yes	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

**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.
standard	Yes	String	Definition Standard type. Constraints N/A Range cn_standard: DJCP MLPS compliance standard hw_standard: Cloud security practice standard 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 The value can contain 0 to 64 characters. Default Value N/A
limit	No	Integer	Definition Number of records displayed on each page. Constraints N/A Range Value range: 10-200 Default Value 10
offset	No	Integer	Definition Offset, which specifies the start position of the record to be returned. Constraints N/A Range The value range is 0 to 2,000,000. Default Value The default value is 0.

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
severity	String	Definition Risk level. Range Low Medium High
check_type	String	Definition Configuration check (baseline) type, for example, SSH, CentOS 7, Windows Server 2019 R2, Windows Server 2016 R2, and MySQL5-Windows. Range N/A
check_type_desc	String	Definition Description of the configuration check (baseline) type, including the standards for the check items contained in the current baseline and the items that can be audited. Range N/A
check_rule_num	Integer	Definition Total number of check items of the current configuration check (baseline) type. For example, if the standard type of the SSH baseline is hw_standard, HSS provides 17 check items, but only five check items of the SSH baseline are checked on all servers. Therefore, the value of check_rule_num is 5. If all the check items are checked on a server, the value of check_rule_num is 17. Range N/A
failed_rule_num	Integer	Definition Number of failed check items. If a server fails to pass a check item in check_rule_num, the item is counted in failed_rule_num. Range N/A
passed_rule_num	Integer	Definition Number of passed check items. If a server passes a check item in check_rule_num, the check item is counted in passed_rule_num. Range N/A
ignored_rule_num	Integer	Definition Number of ignored check items. If a server ignores a check item in check_rule_num, the check item is counted in ignored_rule_num. Range N/A
host_num	Long	Definition Number of affected servers, that is, the number of servers where the current baseline check is performed. Range N/A

Example Requests

This API is used to query the configuration check result list whose baseline name is SSH, check standard is cloud security practice standard, and enterprise project ID is xxx.

GET https://{endpoint}/v5/{project_id}/baseline/risk-config/SSH/detail?standard=hw_standard&enterprise_project_id=xxx

Example Responses

Status code: 200

Request succeeded.

{
  "check_rule_num" : 17,
  "check_type_desc" : "This policy checks the basic security configuration items of the SSH service to improve the security of the SSH service.",
  "failed_rule_num" : 15,
  "host_num" : 2,
  "ignored_rule_num" : 1,
  "passed_rule_num" : 14,
  "severity" : "Medium"
}