Inspecting Server Check Items

Function

This API is used to query lists of servers affected by configuration check items.

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/host/check-rules

**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.
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.
limit	No	Integer	Definition Number of records displayed on each page. Constraints N/A Range Value range: 10-200 Default Value 10
host_id	Yes	String	Definition Server ID. Constraints N/A Range The value can contain 0 to 64 characters. Default Value N/A
policy_group_id	No	String	Definition Policy group ID. Constraints N/A Range The value can contain 0 to 128 characters. Default Value N/A
result_type	No	String	Definition Check result type. Constraints N/A Range safe: The item passed the check. unhandled ignored: ignored fixing: fixing fix-failed: The fix failed. verifying add_to_whitelist: The item has been added to the whitelist. Default Value N/A
standard	Yes	String	Definition Baseline 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
check_name	Yes	String	Definition Configuration check baseline name, for example, SSH, CentOS 7, or Windows. Constraints N/A Range N/A 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
tag	No	String	Definition Baseline check item type. Constraints N/A Range The value can contain 0 to 256 characters. Default Value N/A
severity	No	String	Definition Risk Level Constraints N/A Range Security Low Medium High Critical 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	Definition Total number of servers affected by a single baseline check item. Constraints N/A Range N/A Default Value N/A
data_list	Array of HostCheckRulesResponseInfo objects	Definition Check items of a single server Constraints N/A Range N/A Default Value N/A

**Table 5** HostCheckRulesResponseInfo
Parameter	Type	Description
check_rule_id	String	Definition Check item ID. Range The value can contain 0 to 256 characters.
check_rule_name	String	Definition Check item (rule) name. Range The value can contain 0 to 65,534 characters.
tag	String	Check type of items in the baseline check. Access control Service configuration
severity	String	Risk level. Its value can be: Low Medium High
result_type	String	Definition Check result type. Range safe: The item passed the check. unhandled ignored fixing: fixing fix-failed: The fix failed. verifying add_to_whitelist: The item has been added to the whitelist.
rule_params	Array of CheckRuleFixParamInfo objects	Definition Value range of a parameter that can be configured to fix a check item. This information is only returned for the parameters that can be configured to fix check items.
scan_time	Long	Definition Check Item Scan Time (ms) Range N/A
host_type	String	Definition Server type. If the value is cce, cce is returned. Otherwise, null is returned. Range cce
diff_description	String	Definition Differentiated display of messages. Range The value can contain 0 to 2,048 characters.
description	String	Definition Description about ignoring or whitelisting an item. Range The value can contain 0 to 512 characters.
enable_fix	Integer	Definition Whether one-click fix is supported. Range 1: One-click fix is supported. 0: not supported
enable_click	Boolean	Definition Whether the Fix and Verify buttons of the check item are enabled. Range true: The buttons are enabled. false: The buttons are disabled.
enable_verify	Boolean	Definition Whether the check item can be verified. Linux must be used, and the agent version must be 3.2.24 or later. Range true: verifiable false: unverifiable
cancel_ignore_enable_click	Boolean	Definition Whether an ignored check item can be clicked. Range true: The buttons are enabled. false: The buttons are disabled.
fix_failed_reason	String	Definition Cause of fix failure. Range N/A

**Table 6** CheckRuleFixParamInfo
Parameter	Type	Description
rule_param_id	Integer	Definition Check item parameter ID. Range Value range: 0 to 10
rule_desc	String	Definition Check item parameter description. Range The value can contain 0 to 256 characters.
default_value	Integer	Definition Default values of check item parameters. Range The value range is 0 to 2,147,483,647.
range_min	Integer	Definition Minimum value of check item parameters. Range The value range is 0 to 2,147,483,647.
range_max	Integer	Definition Maximum value of check item parameters. Range The value range is 0 to 2,147,483,647.