Querying Detailed Check Items of a Baseline

Function

This API is used to query detailed check items of a baseline.

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/security-checks/default-policy/details

**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	Yes	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 N/A
limit	Yes	Integer	Definition Number of records displayed on each page. Constraints N/A Range Value range: 10 to 200 Default Value 10
support_os	Yes	String	Definition OS supported by the policy Constraints N/A Range Linux Windows Default Value Linux
check_type	No	String	Definition Configuration check (baseline) type, for example, SSH, CentOS 7, Windows Server 2019 R2, Windows Server 2016 R2, MySQL5-Windows, weakpwd, and pwdcomplexity. Constraints N/A Range The value can contain 0 to 256 characters. Default Value N/A
standard	Yes	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
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_rule_name	No	String	Definition Name of the configuration (baseline) check item. Constraints N/A Range The value can contain 0 to 2,048 characters. Default Value N/A
severity	No	String	Definition Risk level of the configuration (baseline) check item. Constraints N/A Range Low Medium High Default Value N/A
level	No	String	Definition Version information of the configuration (baseline) check item. Constraints N/A Range The value can contain 0 to 32 characters. Default Value N/A
group_id	No	String	Definition Policy group ID Constraints N/A Range Length: 0 to 128 characters Default Value N/A
checked	No	Boolean	Definition Whether it is selected by default. Constraints N/A Range false: deselected true: yes Default Value true

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 check items in the list. Range The value range is 0 to 2,147,483,647.
check_details	Array of SecurityCheckPolicyDetailInfoResponseInfo objects	Definition Check item list

**Table 5** SecurityCheckPolicyDetailInfoResponseInfo
Parameter	Type	Description
key	String	Definition Unique value of a check item. Range The value can contain 0 to 256 characters.
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.
check_rule_type	Integer	Definition Check whether the item type is numeric. Range 1: yes 0: no
check_type	String	Definition Configuration check (baseline) name, for example, SSH, CentOS 7, or Windows. Range The value can contain 0 to 256 characters.
severity	String	Definition Risk level of a check item. Range Low Medium High
level	String	Definition Configuration check (baseline) version information of a check item. Range The value can contain 0 to 32 characters.
checked	Boolean	Definition Whether a check item is selected. Range true: selected false: not selected
rule_params	Array of CheckRuleFixParamInfo objects	Definition Parameters that can be customized.

**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.

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "check_details" : [ {
    "key" : "hw_standard-SSH-AccessControl",
    "check_rule_id" : "1.1",
    "check_rule_name" : "Disable the FTP service. (Auto)",
    "check_rule_type" : 1,
    "check_type" : "SSH",
    "severity" : "High",
    "level" : "level1/level2",
    "checked" : "true",
    "rule_params" : [ {
      "rule_param_id" : 10,
      "rule_desc" : "Number",
      "default_value" : 2147483647,
      "range_min" : 2147483647,
      "range_max" : 2147483647
    } ]
  } ],
  "total_num" : 1
}

Status Codes

Status Code	Description
200	Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Baseline Management

Previous topic: Querying Manual Baseline Scan Results

Next topic: Querying Default Baseline Information of Configuration Check Policy

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