文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 基线管理/ 查询配置检测策略组列表10 - ListSecurityCheckPolicyGroup
更新时间:2025-12-26 GMT+08:00
分享

查询配置检测策略组列表10 - ListSecurityCheckPolicyGroup

功能介绍

查询配置检测策略组列表10。

调用方法

请参见如何调用API

授权信息

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

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

URI

GET /v5/{project_id}/baseline/security-checks/policy-groups

表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

默认取值:

不涉及

limit

Integer

参数解释:

每页显示个数

约束限制:

不涉及

取值范围:

取值10-200

默认取值:

10

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total_num

Integer

参数解释

配置检测总数

取值范围

取值0-1000000

data_list

Array of SecurityCheckPolicyGroupInfoResponseInfo objects

参数解释

数据列表

表5 SecurityCheckPolicyGroupInfoResponseInfo

参数

参数类型

描述

group_id

String

参数解释

策略组ID

取值范围

字符长度1-64位

group_name

String

参数解释

策略组名称

取值范围

字符长度1-256位

check_rule_num

Integer

参数解释

基线检测项(检测规则)数量

取值范围

取值1-10000

host_num

Integer

参数解释

应用服务器数量

取值范围

取值0-1000000

deletable

Boolean

参数解释

是否支持删除

取值范围

  • true:支持

  • false:不支持

default_group

Boolean

参数解释

是否默认策略组

取值范围

  • true:是

  • false:否

support_os

String

参数解释

策略支持的操作系统类型

取值范围

  • Linux:linux系统

  • Windows:windows系统

policy_info

SecurityCheckPolicyInfoResponseInfo object

参数解释

配置检测策略信息

weak_pwd_policy_info

SecurityCheckPolicyInfoResponseInfo object

参数解释

弱口令、口令复杂度检测策略信息

agent_id_list

Array of strings

参数解释

应用的主机的agentID列表

取值范围

字符串大小范围20-64

task_condition

SecurityCheckTaskCondition object

参数解释

定时检测配置

detection_period

String

参数解释

检测周期

取值范围

字符串大小范围1-128

表6 SecurityCheckPolicyInfoResponseInfo

参数

参数类型

描述

content

String

参数解释:

策略详情

取值范围:

最小值0,最大值10241

表7 SecurityCheckTaskCondition

参数

参数类型

描述

type

String

参数解释

定时任务类型

取值范围

  • fixed_weekday : 固定工作日

day_of_week

Array of strings

周几触发,可选0或多个

hour

Integer

参数解释

在此参数表示的小时触发定时任务

取值范围

最小值0,最大值23

minute

Integer

参数解释

在此参数表示的分钟触发定时任务

取值范围

最小值0,最大值59

random_offset

Integer

参数解释

随机偏移时间

取值范围

最小值0,最大值7200

请求示例

查询配置检测策略组列表

GET https://{endpoint}/v5/{project_id}/baseline/security-checks/policy-groups?limit=10&offset=0&enterprise_project_id=all_granted_ep

响应示例

状态码:200

请求已成功

{
  "total_num" : 1004,
  "data_list" : [ {
    "deletable" : true,
    "group_id" : "cfc8b66a-4b3b-42fa-bd94-cd6eacbafc42",
    "group_name" : "复制windows",
    "check_rule_num" : 1,
    "host_num" : 0,
    "default_group" : false,
    "support_os" : "Windows",
    "policy_info" : {
      "content" : "xxx"
    }
  } ]
}

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 ListSecurityCheckPolicyGroupSolution {

    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();
        ListSecurityCheckPolicyGroupRequest request = new ListSecurityCheckPolicyGroupRequest();
        try {
            ListSecurityCheckPolicyGroupResponse response = client.listSecurityCheckPolicyGroup(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 = ListSecurityCheckPolicyGroupRequest()
        response = client.list_security_check_policy_group(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.ListSecurityCheckPolicyGroupRequest{}
	response, err := client.ListSecurityCheckPolicyGroup(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档