Querying Baseline Check Statistics

Function

This API is used to query statistics for baseline checks and display statistics and chart data on the baseline check page, including last scan time, number of checked servers, number of checked baseline items, number of checked server configuration items, pass rate of server configuration baselines, top 5 host configuration risks, weak password detection statistics, and top 5 weak password risks.

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/overview

**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.
group_id	No	String	Definition Policy group ID. If this field is specified, data of the current policy group ID is returned. If this field is not specified, all data of the current enterprise project is returned. Constraints N/A Range The value can contain 0 to 256 characters. Default Value N/A
statistics_type	No	String	Definition Statistical type. Different query types return different statistics. If this parameter is left empty, all data is returned. Constraints N/A Range weakpwd: Query the statistics of servers with weak passwords. baseline_passrate: Query the baseline check pass rate, server configuration baseline pass rate, baseline risk statistics, and failed/total check items. host_risk_top_5: Query the top 5 servers with unsafe settings. host_num: Unsafe/Total Servers 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
scan_time	Long	Definition Latest check time (ms). Range The value range is 0 to 9,223,372,036,854,775,807.
host_num	Integer	Definition Check the number of servers. Range The value range is 0 to 2,147,483,647.
failed_host_num	Integer	Definition Number of unsafe servers. Range The value range is 0 to 2,147,483,647.
check_type_num	Integer	Definition Number of checked baselines. For example, if SSH and CentOS 7 are checked, the value is 2. Range The value range is 0 to 2,147,483,647.
check_rule_num	Integer	Definition Number of baseline check items (rules). For example, if 17 rules are checked in the SSH baseline and 60 rules are checked in the CentOS 7 baseline, the value is 77 (17+60). Range The value range is 0 to 2,147,483,647.
check_rule_pass_rate	Integer	Definition Baseline inspection pass rate. Range The value range is 0 to 2,147,483,647.
cn_standard_check_rule_pass_rate	Integer	Definition Pass rate of cloud security practice baseline check items. Range The value range is 0 to 2,147,483,647.
hw_standard_check_rule_pass_rate	Integer	Definition Pass rate of DJCP MLPS baseline check items. Range The value range is 0 to 2,147,483,647.
check_rule_failed_num	Integer	Definition Number of failed check items Range The value range is 0 to 2,147,483,647.
check_rule_high_risk	Integer	Definition Number of high-risk check items. Range The value range is 0 to 2,147,483,647.
check_rule_medium_risk	Integer	Definition Number of medium-risk check items. Range The value range is 0 to 2,147,483,647.
check_rule_low_risk	Integer	Definition Number of low-risk check items Range The value range is 0 to 2,147,483,647.
weak_pwd_total_host	Integer	Definition Total number of servers where weak password check is performed. Range The value range is 0 to 2,147,483,647.
weak_pwd_risk	Integer	Definition Number of servers where weak passwords are detected. Range The value range is 0 to 2,147,483,647.
weak_pwd_normal	Integer	Definition Number of servers where no weak passwords are detected. Range The value range is 0 to 2,147,483,647.
weak_pwd_not_protected	Integer	Definition Number of servers where no protection is enabled. Range The value range is 0 to 2,147,483,647.
host_risks	Array of HostRiskNumInfoResponseInfo objects	Top 5 server risks
weak_pwd_risk_hosts	Array of HostWeakPwdRiskNumInfoResponseInfo objects	Top 5 servers with weak passwords

**Table 5** HostRiskNumInfoResponseInfo
Parameter	Type	Description
host_id	String	Definition Unique ID of a server (host). Range The value can contain 1 to 64 characters.
host_name	String	Definition Server name. Range The value can contain 1 to 256 characters.
host_ip	String	Definition Server IP Address Range The value can contain 1 to 128 characters.
scan_time	Long	Definition Scan time (ms). Range The value range is 0 to 9,223,372,036,854,775,807.
high_risk_num	Integer	Definition Number of high risks. Range The value range is 0 to 2,147,483,647.
medium_risk_num	Integer	Definition Number of medium risks. Range The value range is 0 to 2,147,483,647.
low_risk_num	Integer	Definition Number of low risks. Range The value range is 0 to 2,147,483,647.

**Table 6** HostWeakPwdRiskNumInfoResponseInfo
Parameter	Type	Description
host_id	String	Definition Unique ID of a server (host). Range The value can contain 1 to 64 characters.
host_name	String	Definition Server name. Range The value can contain 1 to 256 characters.
host_ip	String	Definition Server IP Address Range The value can contain 1 to 128 characters.
weak_pwd_num	Integer	Definition Number of weak passwords. Range The value range is 0 to 2,147,483,647.

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "scan_time" : 1760607432824,
  "host_num" : 100,
  "check_type_num" : 100,
  "check_rule_num" : 100,
  "check_rule_pass_rate" : 100,
  "cn_standard_check_rule_pass_rate" : 100,
  "hw_standard_check_rule_pass_rate" : 100,
  "check_rule_failed_num" : 100,
  "check_rule_high_risk" : 100,
  "check_rule_medium_risk" : 100,
  "check_rule_low_risk" : 100,
  "weak_pwd_total_host" : 100,
  "weak_pwd_risk" : 100,
  "weak_pwd_normal" : 100,
  "weak_pwd_not_protected" : 100,
  "host_risks" : [ {
    "host_id" : "00bd5209-d8df-43af-bf91-5c0cfc965a1b",
    "host_name" : "name",
    "host_ip" : "192.168.1.1",
    "scan_time" : 1760607432824,
    "high_risk_num" : 100,
    "medium_risk_num" : 100,
    "low_risk_num" : 0
  } ],
  "weak_pwd_risk_hosts" : [ {
    "host_id" : "00bd5209-d8df-43af-bf91-5c0cfc965a1b",
    "host_name" : "name",
    "host_ip" : "192.168.1.1",
    "weak_pwd_num" : 100
  } ]
}

Status Codes

Status Code	Description
200	Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Baseline Management

Previous topic: Inspecting Server Check Items

Next topic: Ignoring or Unignoring Servers that Fail the Password Complexity Check

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