# 查询基线检查的统计数据信息 - ShowBaselineOverview #### 功能介绍 查询基线检查的统计数据信息，用来展示基线检查页面的统计数据和图表数据，包括最近检测时间、检测主机数、检测基线数、主机配置检查项数、主机配置基线通过率、主机配置风险top5、主机弱口令检测统计、主机弱口令风险top5等。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-hss2.0/hss_02_0007.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-hss2.0/hss_02_0022.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI GET /v5/{project_id}/baseline/overview 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**: 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-hss2.0/hss_02_0024.html)。 **约束限制**: 不涉及 **取值范围**: 字符长度1-256位 **默认取值**: 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | enterprise_project_id | 否 | String | **参数解释**: 企业项目ID，用于过滤不同企业项目下的资产。获取方式请参见[获取企业项目ID](https://support.huaweicloud.com/api-hss2.0/hss_02_0027.html)。 如需查询所有企业项目下的资产请传参"all_granted_eps"。 **约束限制**: 开通企业项目功能后才需要配置企业项目ID参数。 **取值范围**: 字符长度1-256位 **默认取值**: 0，表示默认企业项目（default）。 | | group_id | 否 | String | **参数解释**: 策略组ID。当传此字段时，返回当前策略组ID下的数据。当不传此字段时，返回当前企业项目下所有数据。 **约束限制**: 不涉及 **取值范围**: 字符长度0-256位 **默认取值**: 不涉及 | | statistics_type | 否 | String | **参数解释** 统计类型，不同的查询类型返回不同的统计数据，为空表示返回所有数据 **约束限制** 不涉及 **取值范围** - weakpwd: 查询主机弱口令检测统计数据 - baseline_passrate: 查询基线检查通过率、主机配置基线通过率、基线风险统计、未通过检查项/已检查项 - host_risk_top_5: 查询主机配置风险TO5 - host_num: 未通过主机/主机总数 **默认取值** 不涉及 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**: 用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见[获取用户Token](https://support.huaweicloud.com/api-hss2.0/hss_02_0009.html)。 **约束限制**: 不涉及 **取值范围**: 字符长度1-32768位 **默认取值**: 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | scan_time | Long | **参数解释**: 最新检测时间(ms)。 **取值范围**: 取值0-9223372036854775807 | | host_num | Integer | **参数解释**: 检查服务器数量。 **取值范围**: 取值0-2147483647 | | failed_host_num | Integer | **参数解释**: 未通过主机数。 **取值范围**: 取值0-2147483647 | | check_type_num | Integer | **参数解释**: 检测基线数量。例如共检测了SSH、CentOS 7这2个配置检测（基线）类型，值就是2。 **取值范围**: 取值0-2147483647 | | check_rule_num | Integer | **参数解释**: 基线检测项（检测规则）数量。例如SSH基线检测了17条规则，CentOS 7基线检测了60条规则，值就是17+60=77。 **取值范围**: 取值0-2147483647 | | check_rule_pass_rate | Integer | **参数解释**: 基线检查项通过率。 **取值范围**: 取值0-2147483647 | | cn_standard_check_rule_pass_rate | Integer | **参数解释**: 云安全实践基线检查项通过率。 **取值范围**: 取值0-2147483647 | | hw_standard_check_rule_pass_rate | Integer | **参数解释**: 等保合规基线检查项通过率。 **取值范围**: 取值0-2147483647 | | check_rule_failed_num | Integer | **参数解释**: 未通过的检查项数量。 **取值范围**: 取值0-2147483647 | | check_rule_high_risk | Integer | **参数解释**: 高危检查项数量。 **取值范围**: 取值0-2147483647 | | check_rule_medium_risk | Integer | **参数解释**: 中危检查项数量。 **取值范围**: 取值0-2147483647 | | check_rule_low_risk | Integer | **参数解释**: 低危检查项数量。 **取值范围**: 取值0-2147483647 | | weak_pwd_total_host | Integer | **参数解释**: 弱口令检测主机总数。 **取值范围**: 取值0-2147483647 | | weak_pwd_risk | Integer | **参数解释**: 弱口令检测结果：有弱口令的主机数。 **取值范围**: 取值0-2147483647 | | weak_pwd_normal | Integer | **参数解释**: 弱口令检测结果：无弱口令的主机数。 **取值范围**: 取值0-2147483647 | | weak_pwd_not_protected | Integer | **参数解释**: 弱口令检测结果：未开启防护的主机数。 **取值范围**: 取值0-2147483647 | | host_risks | Array of [HostRiskNumInfoResponseInfo] objects | 服务器风险TOP5列表 | | weak_pwd_risk_hosts | Array of [HostWeakPwdRiskNumInfoResponseInfo] objects | 主机弱口令风险TOP5列表 | 表5HostRiskNumInfoResponseInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | host_id | String | **参数解释**： 服务器（主机）的唯一标识ID **取值范围**： 字符长度1-64位 | | host_name | String | **参数解释**: 服务器名称 **取值范围**: 字符长度1-256位 | | host_ip | String | **参数解释**: 服务器IP **取值范围**: 字符长度1-128位 | | scan_time | Long | **参数解释**: 扫描时间(ms)。 **取值范围**: 取值0-9223372036854775807 | | high_risk_num | Integer | **参数解释**: 高危风险数量。 **取值范围**: 取值0-2147483647 | | medium_risk_num | Integer | **参数解释**: 中危风险数量。 **取值范围**: 取值0-2147483647 | | low_risk_num | Integer | **参数解释**: 低危风险数量。 **取值范围**: 取值0-2147483647 | 表6HostWeakPwdRiskNumInfoResponseInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | host_id | String | **参数解释**： 服务器（主机）的唯一标识ID **取值范围**： 字符长度1-64位 | | host_name | String | **参数解释**: 服务器名称 **取值范围**: 字符长度1-256位 | | host_ip | String | **参数解释**: 服务器IP **取值范围**: 字符长度1-128位 | | weak_pwd_num | Integer | **参数解释**: 弱口令数量。 **取值范围**: 取值0-2147483647 | #### 请求示例 无 #### 响应示例 **状态码：200** 请求已成功 ``` { "scan_time" : 1760607432824, "host_num" : 100, "check_type_num" : 100, "check_rule_num" : 100, "failed_host_num" : 99, "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 } ] } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.hss.v5.region.HssRegion; import com.huaweicloud.sdk.hss.v5.*; import com.huaweicloud.sdk.hss.v5.model.*; public class ShowBaselineOverviewSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); HssClient client = HssClient.newBuilder() .withCredential(auth) .withRegion(HssRegion.valueOf("")) .build(); ShowBaselineOverviewRequest request = new ShowBaselineOverviewRequest(); try { ShowBaselineOverviewResponse response = client.showBaselineOverview(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` - [Python] ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkhss.v5.region.hss_region import HssRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkhss.v5 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = HssClient.new_builder() \ .with_credentials(credentials) \ .with_region(HssRegion.value_of("")) \ .build() try: request = ShowBaselineOverviewRequest() response = client.show_baseline_overview(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" hss "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := hss.HssClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := hss.NewHssClient(hcClient) request := &model.ShowBaselineOverviewRequest{} response, err := client.ShowBaselineOverview(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/HSS/sdk?api=ShowBaselineOverview&version=v5)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求已成功 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-hss2.0/ErrorCode.html)。