查询指定安全配置项的检查结果
功能介绍
查询指定安全配置项的检查结果
调用方法
请参见如何调用API。
URI
GET /v5/{project_id}/baseline/risk-config/{check_name}/detail
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID |
check_name |
是 |
String |
配置检查(基线)的名称,例如SSH、CentOS 7、Windows |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enterprise_project_id |
否 |
String |
企业项目ID,查询所有企业项目时填写:all_granted_eps |
standard |
是 |
String |
标准类型,包含如下:
|
host_id |
否 |
String |
主机ID,不赋值时,查租户所有主机 |
limit |
否 |
Integer |
每页数量 |
offset |
否 |
Integer |
偏移量:指定返回记录的开始位置 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
severity |
String |
风险等级,包含如下:
|
check_type |
String |
配置检查(基线)的类型,例如SSH、CentOS 7、Windows Server 2019 R2、Windows Server 2016 R2、MySQL5-Windows |
check_type_desc |
String |
对配置检查(基线)类型的描述信息,概括当前基线包含的检查项是根据什么标准制定的,能够审计哪些方面的问题。 |
check_rule_num |
Integer |
当前配置检查(基线)类型下,用户共检测了多少个检查项。例如标准类型为hw_standard的SSH基线,主机安全提供了17个检查项,但用户所有主机都只检测了SSH基线的其中5个检查项,check_rule_num就是5。用户有一台主机进行了全量检查项检测,check_rule_num就是17。 |
failed_rule_num |
Integer |
未通过的检查项数量,check_rule_num中只要有一台主机没通过某个检查项,这个检查项就会被计算在failed_rule_num中 |
passed_rule_num |
Integer |
已通过的检查项数量,check_rule_num中只要有一台主机通过了某个检查项,这个检查项就会被计算在passed_rule_num中 |
ignored_rule_num |
Integer |
已忽略的检查项数量,check_rule_num中只要有一台主机忽略了某个检查项,这个检查项就会被计算在ignored_rule_num中 |
host_num |
Long |
受影响的服务器的数量,进行了当前基线检测的服务器数量 |
请求示例
查询企业项目id为xxx下的基线名称为SSH、标准类型是“云安全实践”标准的配置检测结果列表。
GET https://{endpoint}/v5/{project_id}/baseline/risk-config/SSH/detail?standard=hw_standard&enterprise_project_id=xxx
响应示例
状态码: 200
安全配置项的检查结果
{ "check_rule_num" : 17, "check_type_desc" : "This policy checks the basic security configuration items of the SSH service to improve the security of the SSH service.", "failed_rule_num" : 15, "host_num" : 2, "ignored_rule_num" : 1, "passed_rule_num" : 14, "severity" : "Medium" }
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 48 |
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 ShowRiskConfigDetailSolution { 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(); ShowRiskConfigDetailRequest request = new ShowRiskConfigDetailRequest(); request.withCheckName("{check_name}"); try { ShowRiskConfigDetailResponse response = client.showRiskConfigDetail(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 32 |
# 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 = ShowRiskConfigDetailRequest() request.check_name = "{check_name}" response = client.show_risk_config_detail(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 38 |
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.ShowRiskConfigDetailRequest{} request.CheckName = "{check_name}" response, err := client.ShowRiskConfigDetail(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
安全配置项的检查结果 |
错误码
请参见错误码。