文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 基线管理/ 查询配置检查项影响到的服务器列表 - ListCheckRuleHost
更新时间:2025-12-26 GMT+08:00
分享

查询配置检查项影响到的服务器列表 - ListCheckRuleHost

功能介绍

查询配置检查项影响到的服务器列表。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v5/{project_id}/baseline/check-rule/hosts

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID

如需查询所有企业项目下的资产请传参“all_granted_eps”。

约束限制:

开通企业项目功能后才需要配置企业项目ID参数。

取值范围:

字符长度1-256位

默认取值:

0,表示默认企业项目(default)。

offset

Integer

参数解释:

偏移量:指定返回记录的开始位置

约束限制:

不涉及

取值范围:

最小值0,最大值2000000

默认取值:

默认为0

limit

Integer

参数解释:

每页显示个数

约束限制:

不涉及

取值范围:

取值10-200

默认取值:

10

check_rule_id

String

参数解释

具体基线检查项id

约束限制

不涉及

取值范围

  • 值可以通过这个接口的返回数据获得:/v5/{project_id}/baseline/risk-config/{check_name}/check-rules

默认取值

不涉及

check_name

String

参数解释

配置检查(基线)的名称,如SSH、CentOS 7、Windows,与check_type相比,会多-PID之类的进程信息,通过具体基线维度查询时,传check_name

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

check_type

String

参数解释

配置检查(基线)的类型,如SSH、CentOS 7、Windows,通过检查项维度查询时,传check_type

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

standard

String

参数解释

基线分类

约束限制

不涉及

取值范围

  • cn_standard : 等保合规标准

  • hw_standard : 云安全实践标准

  • cis_standard:通用安全标准

默认取值

不涉及

result_type

String

参数解释

检测结果类型

约束限制

不涉及

取值范围

  • safe : 已通过

  • unhandled : 未处理

  • ignored : 已忽略

  • fixing : 修复中

  • fix-failed : 修复失败

  • verifying : 验证中

  • add_to_whitelist : 已加白

默认取值

不涉及

cluster_id

String

参数解释

集群ID

约束限制

不涉及

取值范围

字符长度0-64位

默认取值

不涉及

host_name

String

参数解释

主机名称或ip

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

host_type

String

参数解释

主机类型,已废弃

约束限制

不涉及

取值范围

  • cce

默认取值

不涉及

check_cce

Boolean

参数解释:

是否只筛选cce主机,已废弃

约束限制:

不涉及

取值范围:

-true:是。

-false:否。

默认取值:

false

policy_group_id

String

参数解释

策略组ID,已废弃

约束限制

不涉及

取值范围

字符长度0-128位

默认取值

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total_num

Long

参数解释

单个基线检查项影响的主机总量

取值范围

取值0-2147483647

data_list

Array of SecurityCheckRuleHostResponseInfo objects

参数解释

单个基线检查项受影响的主机列表

取值范围

最少0条,最多2147483647条

表5 SecurityCheckRuleHostResponseInfo

参数

参数类型

描述

host_id

String

参数解释

服务器(主机)的唯一标识ID

取值范围

字符长度1-64位

host_name

String

参数解释:

服务器名称

取值范围:

字符长度1-256位

check_name

String

参数解释

配置检查(基线)的名称,例如SSH、CentOS 7、Windows

取值范围

字符长度0-256位

baseline_name

String

参数解释

基线的名称,例如SSH 应用基线检查、CentOS 7 系统基线检查、Windows 系统基线检查

取值范围

字符长度0-256位

host_public_ip

String

参数解释:

服务器公网IP

取值范围:

字符长度0-128位

host_private_ip

String

参数解释

服务器私有IP

取值范围

字符长度0-256位

scan_time

Long

参数解释

扫描时间(ms)

取值范围

取值0-9223372036854775807

failed_num

Integer

参数解释

风险项数量

取值范围

取值0-2147483647

passed_num

Integer

参数解释

通过项数量

取值范围

取值0-2147483647

diff_description

String

参数解释

差异化展示提示信息

取值范围

字符长度0-512位

description

String

参数解释

忽略或加白的备注

取值范围

字符长度0-1024位

host_type

String

参数解释

主机类型,当主机为cce类型时,返回cce

取值范围

  • cce

enable_fix

Integer

参数解释

是否支持一键修复

取值范围

  • 1 : 支持一键修复

  • 0 : 不支持

enable_verify

Boolean

参数解释

该检查项是否可验证,要求为Linux且agent版本>=3.2.24

取值范围

  • true : 可验证

  • false : 不可验证

enable_click

Boolean

参数解释

该检查项的修复&忽略&验证按钮是否可单击

取值范围

  • true : 按钮可单击

  • false : 按钮不可单击

cancel_ignore_enable_click

Boolean

参数解释

已忽略检查项是否可点击

取值范围

  • true : 按钮可单击

  • false : 按钮不可单击

result_type

String

参数解释

检测结果类型

取值范围

  • safe : 已通过

  • unhandled : 未处理

  • ignored : 已忽略

  • fixing : 修复中

  • fix-failed : 修复失败

  • verifying : 验证中

  • add_to_whitelist : 已加白(表示检测失败,但已进行加白)

fix_failed_reason

String

参数解释

修复失败原因

取值范围

字符长度0-256位

cluster_id

String

参数解释

集群ID

取值范围

字符长度0-64位

请求示例

响应示例

状态码:200

请求已成功

{
  "data_list" : [ {
    "host_id" : "852d2054-ae2e-11f0-a086-fa163e358d0a",
    "host_name" : "name",
    "check_name" : "SSH",
    "host_private_ip" : "192.168.0.108",
    "result_type" : "unhandled",
    "scan_time" : 1760988017640
  } ],
  "total_num" : 1
}

SDK代码示例

SDK代码示例如下。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
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 ListCheckRuleHostSolution {

    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("<YOUR REGION>"))
                .build();
        ListCheckRuleHostRequest request = new ListCheckRuleHostRequest();
        try {
            ListCheckRuleHostResponse response = client.listCheckRuleHost(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());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# 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("<YOUR REGION>")) \
        .build()

    try:
        request = ListCheckRuleHostRequest()
        response = client.list_check_rule_host(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := hss.NewHssClient(
        hss.HssClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListCheckRuleHostRequest{}
	response, err := client.ListCheckRuleHost(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档