查询指定安全配置项的检查项列表
功能介绍
查询指定安全配置项的检查项列表
调用方法
请参见如何调用API。
URI
GET /v5/{project_id}/baseline/risk-config/{check_name}/check-rules
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID 最小长度:20 最大长度:64 |
check_name |
是 |
String |
配置检查(基线)的名称,例如SSH、CentOS 7、Windows 最小长度:0 最大长度:256 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enterprise_project_id |
否 |
String |
企业项目ID,查询所有企业项目时填写:all_granted_eps 最小长度:0 最大长度:64 |
standard |
是 |
String |
标准类型,包含如下:
最小长度:0 最大长度:32 |
result_type |
否 |
String |
结果类型,包含如下:
缺省值:unhandled 最小长度:0 最大长度:64 |
check_rule_name |
否 |
String |
检查项(检查规则)名称,支持模糊匹配 最小长度:0 最大长度:2048 |
severity |
否 |
String |
风险等级,包含如下:
最小长度:0 最大长度:255 |
host_id |
否 |
String |
主机ID,不赋值时,查租户所有主机 最小长度:0 最大长度:64 |
limit |
否 |
Integer |
每页数量 最小值:0 最大值:200 缺省值:10 |
offset |
否 |
Integer |
偏移量:指定返回记录的开始位置 最小值:0 最大值:2000000 缺省值:0 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 最小长度:32 最大长度:2097152 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
total_num |
Long |
风险总数 最小值:0 最大值:9223372036854775807 |
data_list |
Array of CheckRuleRiskInfoResponseInfo objects |
数据列表 数组长度:0 - 2147483647 |
参数 |
参数类型 |
描述 |
---|---|---|
severity |
String |
风险等级,包含如下:
最小长度:0 最大长度:255 |
check_name |
String |
配置检查(基线)的名称,例如SSH、CentOS 7、Windows 最小长度:0 最大长度:256 |
check_type |
String |
配置检查(基线)的类型,Linux系统支持的基线一般check_type和check_name相同,例如SSH、CentOS 7。 Windows系统支持的基线一般check_type和check_name不相同,例如check_name为Windows的配置检查(基线),它的check_type包含Windows Server 2019 R2、Windows Server 2016 R2等。 最小长度:0 最大长度:256 |
standard |
String |
标准类型,包含如下:
最小长度:0 最大长度:16 |
check_rule_name |
String |
检查项(检查规则)名称 最小长度:0 最大长度:2048 |
check_rule_id |
String |
检查项ID 最小长度:0 最大长度:64 |
host_num |
Integer |
受影响的服务器的数量,进行了当前基线检测的服务器数量 最小值:0 最大值:2147483647 |
scan_result |
String |
检测结果,包含如下:
最小长度:0 最大长度:64 |
status |
String |
状态,包含如下:
最小长度:0 最大长度:64 |
enable_fix |
Integer |
是否支持一键修复,1:支持一键修复,0:不支持 最小值:0 最大值:2147483647 |
enable_click |
Boolean |
该检查项的修复&忽略&验证按钮是否可单击,true:按钮可单击,false:按钮不可单击 |
rule_params |
Array of CheckRuleFixParamInfo objects |
支持传递参数修复的检查项可传递参数的范围,只有支持传递参数修复的检查项才返回此数据 数组长度:0 - 2147483647 |
请求示例
查询企业项目id为xxx下的基线名称为SSH、检查标准为“云安全实践”的检查项列表。
GET https://{endpoint}/v5/{project_id}/baseline/risk-config/SSH/check-rules?standard=hw_standard&enterprise_project_id=xxx { "standard" : "hw_standard" }
响应示例
状态码: 200
指定安全配置项的检查项列表
{ "total_num" : 1, "data_list" : [ { "check_rule_id" : "1.1", "check_rule_name" : "Rule:Ensure that permissions on /etc/ssh/sshd_config are configured.", "check_type" : "SSH", "host_num" : 2, "standard" : "hw_standard", "scan_result" : "failed", "severity" : "High", "status" : "unhandled", "enable_fix" : 1, "enable_click" : true, "rule_params" : [ { "rule_param_id" : 1, "rule_desc" : "设置超时时间", "default_value" : 5, "range_min" : 1, "range_max" : 10 }, { "rule_param_id" : 2, "rule_desc" : "设置重启次数", "default_value" : 10, "range_min" : 1, "range_max" : 20 } ] } ] }
SDK代码示例
SDK代码示例如下。
查询企业项目id为xxx下的基线名称为SSH、检查标准为“云安全实践”的检查项列表。
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 48 49 50 51 52 53 |
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 ListRiskConfigCheckRulesSolution { 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"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); HssClient client = HssClient.newBuilder() .withCredential(auth) .withRegion(HssRegion.valueOf("<YOUR REGION>")) .build(); ListRiskConfigCheckRulesRequest request = new ListRiskConfigCheckRulesRequest(); request.withEnterpriseProjectId("<enterprise_project_id>"); request.withStandard("<standard>"); request.withResultType("<result_type>"); request.withCheckRuleName("<check_rule_name>"); request.withSeverity("<severity>"); request.withHostId("<host_id>"); request.withLimit(<limit>); request.withOffset(<offset>); try { ListRiskConfigCheckRulesResponse response = client.listRiskConfigCheckRules(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()); } } } |
查询企业项目id为xxx下的基线名称为SSH、检查标准为“云安全实践”的检查项列表。
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 |
# 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"] credentials = BasicCredentials(ak, sk) client = HssClient.new_builder() \ .with_credentials(credentials) \ .with_region(HssRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListRiskConfigCheckRulesRequest() request.enterprise_project_id = "<enterprise_project_id>" request.standard = "<standard>" request.result_type = "<result_type>" request.check_rule_name = "<check_rule_name>" request.severity = "<severity>" request.host_id = "<host_id>" request.limit = <limit> request.offset = <offset> response = client.list_risk_config_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) |
查询企业项目id为xxx下的基线名称为SSH、检查标准为“云安全实践”的检查项列表。
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 48 49 50 |
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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := hss.NewHssClient( hss.HssClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListRiskConfigCheckRulesRequest{} enterpriseProjectIdRequest:= "<enterprise_project_id>" request.EnterpriseProjectId = &enterpriseProjectIdRequest request.Standard = "<standard>" resultTypeRequest:= "<result_type>" request.ResultType = &resultTypeRequest checkRuleNameRequest:= "<check_rule_name>" request.CheckRuleName = &checkRuleNameRequest severityRequest:= "<severity>" request.Severity = &severityRequest hostIdRequest:= "<host_id>" request.HostId = &hostIdRequest limitRequest:= int32(<limit>) request.Limit = &limitRequest offsetRequest:= int32(<offset>) request.Offset = &offsetRequest response, err := client.ListRiskConfigCheckRules(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
指定安全配置项的检查项列表 |
错误码
请参见错误码。