# 查看主机对应的检查项 - ListHostCheckRules #### 功能介绍 查询配置检查项影响到的服务器列表。 #### 调用方法 请参见[如何调用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/host/check-rules 表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）。 | | offset | 否 | Integer | **参数解释**: 偏移量：指定返回记录的开始位置 **约束限制**: 不涉及 **取值范围**: 最小值0，最大值2000000 **默认取值**: 默认为0 | | limit | 否 | Integer | **参数解释**: 每页显示个数 **约束限制**: 不涉及 **取值范围**: 取值10-200 **默认取值**: 10 | | host_id | 是 | String | **参数解释** 主机ID **约束限制** 不涉及 **取值范围** 字符长度0-64位 **默认取值** 不涉及 | | policy_group_id | 否 | String | **参数解释** 策略组ID **约束限制** 不涉及 **取值范围** 字符长度0-128位 **默认取值** 不涉及 | | result_type | 否 | String | **参数解释** 检测结果类型 **约束限制** 不涉及 **取值范围** - safe：已通过 - unhandled： 未处理 - ignored：已忽略 - fixing：修复中 - fix-failed：修复失败 - verifying：验证中 - add_to_whitelist：已加白 **默认取值** 不涉及 | | standard | 是 | String | **参数解释** 基线分类 **约束限制** 不涉及 **取值范围** - cn_standard：等保合规标准 - hw_standard：云安全实践标准 - cis_standard：通用安全标准 **默认取值** 不涉及 | | check_name | 是 | String | **参数解释** 配置检查（基线）的名称，如SSH、CentOS 7、Windows **约束限制** 不涉及 **取值范围** 不涉及 **默认取值** 不涉及 | | check_rule_name | 否 | String | **参数解释** 检查项（检查规则）名称，支持模糊匹配 **约束限制** 不涉及 **取值范围** 字符长度0-2048位 **默认取值** 不涉及 | | tag | 否 | String | **参数解释** 基线检查项的类型 **约束限制** 不涉及 **取值范围** 字符长度0-256位 **默认取值** 不涉及 | | severity | 否 | String | **参数解释** 风险等级 **约束限制** 不涉及 **取值范围** - Security：安全 - Low：低危 - Medium：中危 - High：高危 - Critical：危急 **默认取值** 不涉及 | #### 请求参数 表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参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total_num | Integer | **参数解释** 单个基线检查项影响的主机总量 **取值范围** 不涉及 | | data_list | Array of [HostCheckRulesResponseInfo] objects | **参数解释** 单个主机涉及的检查项列表 **取值范围** 不涉及 | 表5HostCheckRulesResponseInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | check_rule_id | String | **参数解释** 检查项id **取值范围** 字符长度0-256位 | | check_rule_name | String | **参数解释** 检查项（检查规则）名称 **取值范围** 字符长度0-65534位 | | tag | String | 基线检查中检查项的检查类型 - 访问控制 - 服务配置 | | severity | String | 风险等级，包含如下: - Low : 低危 - Medium : 中危 - High : 高危 | | result_type | String | **参数解释** 检测结果类型 **取值范围** - safe : 已通过 - unhandled : 未处理 - ignored : 已忽略 - fixing : 修复中 - fix-failed : 修复失败 - verifying : 验证中 - add_to_whitelist : 已加白 | | rule_params | Array of [CheckRuleFixParamInfo] objects | **参数解释** 支持传递参数修复的检查项可传递参数的范围，只有支持传递参数修复的检查项才返回此数据 | | scan_time | Long | **参数解释** 检查项扫描时间(ms) **取值范围** 不涉及 | | host_type | String | **参数解释** 主机类型，是cce则返回cce，否则返回null **取值范围** - cce | | diff_description | String | **参数解释** 差异化展示提示信息 **取值范围** 字符长度0-2048位 | | description | String | **参数解释** 忽略或加白的描述 **取值范围** 字符长度0-512位 | | enable_fix | Integer | **参数解释** 是否支持一键修复 **取值范围** - 1 : 支持一键修复 - 0 : 不支持 | | enable_click | Boolean | **参数解释** 该检查项的修复 \& 验证 按钮是否可单击 **取值范围** - true : 按钮可单击 - false : 按钮不可单击 | | enable_verify | Boolean | **参数解释** 该检查项是否可验证，要求为Linux且agent版本\>=3.2.24 **取值范围** - true : 可验证 - false : 不可验证 | | cancel_ignore_enable_click | Boolean | **参数解释** 已忽略检查项是否可点击 **取值范围** - true : 按钮可单击 - false : 按钮不可单击 | | fix_failed_reason | String | **参数解释** 修复失败原因 **取值范围** 不涉及 | 表6CheckRuleFixParamInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | rule_param_id | Integer | **参数解释** 检查项参数ID **取值范围** 取值0-10 | | rule_desc | String | **参数解释** 检查项参数描述 **取值范围** 字符长度0-256位 | | default_value | Integer | **参数解释** 检查项参数默认值 **取值范围** 取值0-2147483647 | | range_min | Integer | **参数解释** 检查项参数可取最小值 **取值范围** 取值0-2147483647 | | range_max | Integer | **参数解释** 检查项参数可取最大值 **取值范围** 取值0-2147483647 | #### 请求示例 无 #### 响应示例 **状态码：200** 请求已成功 ``` { "total_num" : 1, "data_list" : [ { "check_rule_id" : "xxx", "check_rule_name" : "xxx", "tag" : "xxx", "severity" : "xxx", "result_type" : "xxx", "rule_params" : [ { "rule_param_id" : 1, "rule_desc" : "xxx", "default_value" : 1, "range_min" : 1, "range_max" : 1 } ], "scan_time" : 1, "host_type" : "xxx", "diff_description" : "xxx", "enable_fix" : 1, "enable_click" : true, "enable_verify" : true, "cancel_ignore_enable_click" : true, "fix_failed_reason" : "xxx" } ] } ``` #### 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 ListHostCheckRulesSolution { 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(); ListHostCheckRulesRequest request = new ListHostCheckRulesRequest(); try { ListHostCheckRulesResponse response = client.listHostCheckRules(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 = ListHostCheckRulesRequest() response = client.list_host_check_rules(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.ListHostCheckRulesRequest{} response, err := client.ListHostCheckRules(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=ListHostCheckRules&version=v5)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求已成功 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-hss2.0/ErrorCode.html)。