Querying the Impact Scope of a Baseline Check

Function

This API is used to query the impact scope of a baseline check.

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

POST /v5/{project_id}/baseline/check-rule/handle-affect-baseline

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

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

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
action	Yes	String	Definition Operation performed during the baseline check Constraints N/A Range add_to_whitelist ignore unignore fix verify Default Value** N/A
handle_status	Yes	String	Definition Status of the current check items Constraints N/A Range unhandled fix-failed fixing verifying ignored safe Default Value N/A
host_id	No	String	Definition Host ID. If this field does not exist, the check item affects some hosts. Constraints N/A Range The value contains 1 to 256 characters. Default Value N/A
check_rule_list	Yes	Array of check_rule_list objects	Details: Check items to be operated Constraints List range: 0 - 200

**Table 5** check_rule_list
Parameter	Mandatory	Type	Description
check_name	No	String	Definition Name of a baseline check Constraints N/A Range The value contains 0 to 256 characters. Default Value N/A
check_rule_id	No	String	Definition Check item ID. Constraints N/A Range The value contains 0 to 256 characters. Default Value N/A
standard	No	String	Definition Baseline check 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

Response Parameters

Status code: 200

**Table 6** Response body parameters
Parameter	Type	Description
total_rule_num	Integer	Definition Total number of affected items Range 0 to 5000
rule_num	Integer	Definition Number of check items affected by the operation Range 0 to 5000
host_num	Integer	Definition Number of hosts affected by the operation Range 0 to 5000
data_list	Array of HandleAffectBaselineInfo objects	Details: Detailed information about the operation impact scope

**Table 7** HandleAffectBaselineInfo
Parameter	Type	Description
host_id	String	Definition Host ID. Range The value contains 1 to 256 characters.
host_name	String	Definition Server Name Range The value contains 1 to 64 characters.
public_ip	String	Definition Server public IP address Range The value contains 0 to 128 characters.
private_ip	String	Definition Server private IP address Range The value contains 0 to 2,048 characters.
asset_value	String	Definition Asset importance. Its value can be: Range important: important asset common: common asset test**: test asset
check_type	String	Definition Name of the baseline check. Range The value contains 0 to 255 characters.
standard	String	Definition Standard type. The options are as follows: Range cn_standard: DJCP MLPS compliance standard hw_standard: Cloud security practice standard cis_standard**: general security standard
tag	String	Definition Check type of check items in the baseline check. Range The value contains 0 to 128 characters.
check_rule_name	String	Definition Name of check items in the baseline check. Range The value contains 0 to 2,048 characters.

Example Requests

Request parameter for querying the impact scope of a baseline check operation.

POST https://{endpoint}/v5/2b31ed520xxxxxxebedb6e57xxxxxxxx/baseline/check-rule/handle-affect-baseline?action=ignore&enterprise_project_id=all_granted_eps

{
  "action" : "add_to_whitelist",
  "handle_status" : "unhandled",
  "host_id" : "868d6b67-b436-4c40-af5f-97b8ae95a45e",
  "check_rule_list" : [ {
    "check_name" : "SSH",
    "check_rule_id" : 1.11,
    "standard" : "hw_standard"
  } ]
}

Example Responses

Status code: 200

Request succeeded.

{
  "total_rule_num" : 3,
  "rule_num" : 2,
  "host_num" : 2,
  "data_list" : [ {
    "host_id" : "40371a5d-11df-30fc-80fb-a7b61715cd92",
    "host_name" : "DESKTOP-Q3H4UP1",
    "asset_value" : "common",
    "public_ip" : "10.122.112.21",
    "private_ip" : "192.168.10.5",
    "check_type" : "SSH",
    "standard" : "hw_standard",
    "tag" : "Access control",
    "check_rule_name" : "Rule: Restrict the access permission on **/etc/ssh/sshd_config**."
  } ]
}

Status Codes

Status Code	Description
200	Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Baseline Management

Previous topic: Querying Causes of Check Item Repair Failures

Next topic: Querying Lists of Servers Affected by Configuration Check Items

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