文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 基线策略/ 查询基线检测策略的基线目录信息
更新时间:2025-08-01 GMT+08:00
分享

查询基线检测策略的基线目录信息

功能介绍

查询基线检测策略的基线目录信息

调用方法

请参见如何调用API

URI

GET /v5/{project_id}/baseline/security-checks/directory

表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)。

support_os

String

参数解释

基线检查的操作系统

约束限制

不涉及

取值范围

  • Linux

  • Windows

默认取值

Linux

select_type

String

参数解释

决定目录结构的顺序

约束限制

不涉及

取值范围

  • check_type : 二级目录为基线名称

  • tag : 二级目录为检查项的类型

默认取值

不涉及

group_id

String

参数解释

展示该策略组选中哪些检查项

约束限制

不涉及

取值范围

字符长度0-64位

默认取值

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

task_condition

SecurityCheckTaskCondition object

定时检测配置

baseline_directory_list

Array of ShowBaselineDirectoryInfo objects

参数解释

基线检查策略目录

pwd_directory_list

Array of ShowPwdDirectoryInfo objects

参数解释

基线检查策略目录

表5 SecurityCheckTaskCondition

参数

参数类型

描述

type

String

定时任务,包含如下:

  • fixed_weekday : 固定工作日

day_of_week

Array of strings

周几触发,可选0或多个

hour

Integer

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

minute

Integer

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

random_offset

Integer

随机偏移时间

表6 ShowBaselineDirectoryInfo

参数

参数类型

描述

type

String

根据select_type不同的值,得到不同的含义

  • 当select_type为check_type,该字段代表check_type(基线的名称)

  • 当select_type为tag,该字段代表tag(基线检查项的类型)

standard

String

标准类型,包含如下:

  • cn_standard : 等保合规标准

  • hw_standard : 云安全实践标准

  • cis_standard : 通用安全标准

data_list

Array of data_list objects

基线检查策略三级目录信息

表7 data_list

参数

参数类型

描述

name

String

根据select_type不同的值,得到不同的含义

  • 当select_type为check_type,该字段代表tag(基线检查项的类型)

  • 当select_type为tag,该字段代表check_type(基线的名称)

enable

Boolean

该项是否被选中

表8 ShowPwdDirectoryInfo

参数

参数类型

描述

tag

String

弱口令及口令复杂度一级标签,包含如下:

  • weakpwd_pwdcomplexity : 弱口令及口令复杂度检测

  • weakpwd : 弱口令检测

sub_tag

String

口令检查包含子标签,包含如下:

  • weak_pwd : 经典弱口令检测

  • pwd_complexity : 口令复杂度策略检

checked

Boolean

参数解释

该项是否被选中

取值范围

  • true : 被选中

  • false: 未被选中

key

String

表示目录中的唯一值:

  • weak_pwd : 经典弱口令检测

  • pwd_complexity : 口令复杂度策略检测

请求示例

响应示例

状态码:200

请求已成功

{
  "task_condition" : {
    "type" : "fixed_weekday",
    "day_of_week" : [ "mon", "sun" ],
    "hour" : 4,
    "minute" : 0,
    "random_offset" : 3600
  },
  "baseline_directory_list" : [ {
    "type" : "SSH",
    "standard" : "cn_standard",
    "data_list" : [ {
      "name" : "访问控制",
      "checked" : true,
      "key" : "SSH-cn_standard-访问控制"
    }, {
      "name" : "服务部署",
      "checked" : true,
      "key" : "SSH-cn_standard-服务部署"
    } ]
  }, {
    "type" : "Apache",
    "standard" : "hw_standard",
    "data_list" : [ {
      "name" : "访问控制",
      "checked" : false,
      "key" : "Apache-hw_standard-访问控制"
    }, {
      "name" : "服务部署",
      "checked" : true,
      "key" : "Apache-hw_standard-服务部署"
    } ]
  } ],
  "pwd_directory_list" : [ {
    "tag" : "weakpwd_pwdcomplexity",
    "sub_tag" : "weakpwd",
    "checked" : true,
    "key" : "weakpwd"
  }, {
    "tag" : "weakpwd_pwdcomplexity",
    "sub_tag" : "pwdcomplexity",
    "checked" : true,
    "key" : "pwdcomplexity"
  } ]
}

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

    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();
        ShowBaselineDirectoryRequest request = new ShowBaselineDirectoryRequest();
        try {
            ShowBaselineDirectoryResponse response = client.showBaselineDirectory(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 = ShowBaselineDirectoryRequest()
        response = client.show_baseline_directory(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.ShowBaselineDirectoryRequest{}
	response, err := client.ShowBaselineDirectory(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档