查询集群的安全体检报告信息
功能介绍
查询集群的安全体检报告信息
调用方法
请参见如何调用API。
URI
GET /v5/{project_id}/security-check/containers/cluster-reports/{report_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
report_id |
是 |
String |
参数解释: 集群的安全体检报告ID 约束限制: 不涉及 取值范围: 字符长度1-64位 默认取值: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0,表示默认企业项目(default)。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
x-language |
否 |
String |
language |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
scan_time |
Long |
参数解释: 体检时间 取值范围: 不涉及 |
cluster_id |
String |
参数解释: 集群ID 取值范围: 不涉及 |
cluster_name |
String |
参数解释: 集群名称 取值范围: 不涉及 |
cluster_category |
String |
参数解释: 集群类型 取值范围:
|
local_image_vul_num |
Integer |
参数解释: 本地镜像漏洞风险数量 取值范围: 不涉及 |
risk_config_num |
Integer |
参数解释: 基线风险数量 取值范围: 不涉及 |
privileged_container_num |
Integer |
参数解释: 特权容器数量 取值范围: 不涉及 |
pod_num |
Integer |
参数解释: pod数量 取值范围: 不涉及 |
host_num |
Integer |
参数解释: 节点数量 取值范围: 不涉及 |
container_num |
Integer |
参数解释: 容器数量 取值范围: 不涉及 |
port_num |
Integer |
参数解释: 端口数量 取值范围: 不涉及 |
process_num |
Integer |
参数解释: 进程数量 取值范围: 不涉及 |
app_num |
Integer |
参数解释: 软件数量 取值范围: 不涉及 |
local_image_vul_list |
Array of ClusterSecurityCheckLocalImageVulInfo objects |
参数解释: 本地镜像漏洞列表 取值范围: 不涉及 |
baseline_detection_list |
Array of ClusterSecurityCheckBaseLineDetectionInfo objects |
参数解释: 基线检测列表 取值范围: 不涉及 |
privileged_container_list |
Array of ClusterSecurityCheckPrivilegedContainerInfo objects |
参数解释: 特权容器列表 取值范围: 不涉及 |
port_list |
Array of ClusterSecurityCheckPortInfo objects |
参数解释: 端口列表 取值范围: 不涉及 |
app_list |
Array of ClusterSecurityCheckAppInfo objects |
参数解释: 软件列表 取值范围: 不涉及 |
process_list |
Array of ClusterSecurityCheckProcessInfo objects |
参数解释: 进程列表 取值范围: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
local_image_name |
String |
参数解释: 本地镜像名称 取值范围: 不涉及 |
local_image_version |
String |
参数解释: 本地镜像版本 取值范围: 不涉及 |
local_image_size |
Long |
参数解释: 本地镜像大小 取值范围: 不涉及 |
vul_name |
String |
参数解释: 漏洞名称 取值范围: 不涉及 |
app_name |
String |
参数解释: 软件名称 取值范围: 不涉及 |
app_version |
String |
参数解释: 软件版本 取值范围: 不涉及 |
severity_level |
String |
参数解释: 漏洞危险程度 取值范围:
|
solution |
String |
参数解释: 漏洞解决方案 取值范围: 不涉及 |
vul_description |
String |
参数解释: 漏洞描述 取值范围: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
severity |
String |
参数解释: 基线风险级别 取值范围:
|
check_name |
String |
参数解释: 基线名称 取值范围: 不涉及 |
check_type |
String |
参数解释: 基线类型 取值范围: 不涉及 |
standard |
String |
参数解释: 标准类型 取值范围:
|
check_rule_num |
Integer |
参数解释: 检查项数量 取值范围: 不涉及 |
failed_rule_num |
Integer |
参数解释: 风险项数量 取值范围: 不涉及 |
check_type_desc |
String |
参数解释: 基线描述信息 取值范围: 不涉及 |
baseline_item_list |
Array of ClusterSecurityCheckBaselineItemInfo objects |
参数解释: 基线检测列表 取值范围: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
severity |
String |
参数解释: 检查项风险等级 取值范围:
|
check_item |
String |
参数解释: 检查项 取值范围: 不涉及 |
check_description |
String |
参数解释: 检查描述 取值范围: 不涉及 |
check_remediation |
String |
参数解释: 修复建议 取值范围: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
container_name |
String |
参数解释: 容器名称 取值范围: 不涉及 |
container_id |
String |
参数解释: 容器ID 取值范围: 不涉及 |
container_status |
String |
参数解释: 容器状态 取值范围:
|
pod_name |
String |
参数解释: pod名称 取值范围: 不涉及 |
host_name |
String |
参数解释: 节点名称 取值范围: 不涉及 |
private_ip |
String |
参数解释: 私有IP地址 取值范围: 不涉及 |
public_ip |
String |
参数解释: 公有IP地址 取值范围: 不涉及 |
event_abstract |
String |
参数解释: 事件摘要 取值范围: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
port |
Integer |
参数解释: 端口号 取值范围: 不涉及 |
container_id |
String |
参数解释: 容器ID 取值范围: 不涉及 |
container_name |
String |
参数解释: 容器名称 取值范围: 不涉及 |
pod_name |
String |
参数解释: pod名称 取值范围: 不涉及 |
host_name |
String |
参数解释: 节点名称 取值范围: 不涉及 |
private_ip |
String |
参数解释: 私有IP地址 取值范围: 不涉及 |
public_ip |
String |
参数解释: 公有IP地址 取值范围: 不涉及 |
path |
String |
参数解释: 程序文件 取值范围: 不涉及 |
pid |
Integer |
参数解释: 进程PID 取值范围: 不涉及 |
laddr |
String |
参数解释: 监听IP 取值范围: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
app_name |
String |
参数解释: 软件名称 取值范围: 不涉及 |
app_version |
String |
参数解释: 软件版本 取值范围: 不涉及 |
container_id |
String |
参数解释: 容器ID 取值范围: 不涉及 |
container_name |
String |
参数解释: 容器名称 取值范围: 不涉及 |
host_name |
String |
参数解释: 节点名称 取值范围: 不涉及 |
private_ip |
String |
参数解释: 私有IP地址 取值范围: 不涉及 |
public_ip |
String |
参数解释: 公有IP地址 取值范围: 不涉及 |
update_time |
Long |
参数解释: 更新时间 取值范围: 不涉及 |
recent_scan_time |
Long |
参数解释: 最近扫描时间 取值范围: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
container_id |
String |
参数解释: 容器ID 取值范围: 不涉及 |
container_name |
String |
参数解释: 容器名称 取值范围: 不涉及 |
host_name |
String |
参数解释: 节点名称 取值范围: 不涉及 |
private_ip |
String |
参数解释: 私有IP地址 取值范围: 不涉及 |
public_ip |
String |
参数解释: 公有IP地址 取值范围: 不涉及 |
start_time |
Long |
参数解释: 启动时间 取值范围: 不涉及 |
pid |
Integer |
参数解释: 进程PID 取值范围: 不涉及 |
permission |
String |
参数解释: 文件权限 取值范围: 不涉及 |
user_name |
String |
参数解释: 运行用户 取值范围: 不涉及 |
launch_params |
String |
参数解释: 启动参数 取值范围: 不涉及 |
hash |
String |
参数解释: 文件hash 取值范围: 不涉及 |
请求示例
无
响应示例
状态码:200
请求已成功
{ "scan_time" : 1745051197000, "cluster_id" : "27716-6331ef-02c62-11958-f55d39", "cluster_name" : "test-cluster", "cluster_category" : "CCE", "local_image_vul_num" : 1, "risk_config_num" : 1, "privileged_container_num" : 1, "pod_num" : 1, "host_num" : 1, "container_num" : 1, "port_num" : 1, "process_num" : 1, "app_num" : 1, "local_image_vul_list" : { "local_image_name" : "test-image", "local_image_version" : "1.0.0", "local_image_size" : 10, "vul_name" : "test-vul", "app_name" : "test-app", "app_version" : "1.0.0", "severity_level" : "Low", "solution" : "solution", "vul_description" : "description" }, "baseline_detection_list" : [ ], "privileged_container_list" : [ ], "port_list" : [ ], "app_list" : [ ], "process_list" : [ ] }
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 ShowSecurityCheckClusterReportSolution { 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(); ShowSecurityCheckClusterReportRequest request = new ShowSecurityCheckClusterReportRequest(); request.withReportId("{report_id}"); try { ShowSecurityCheckClusterReportResponse response = client.showSecurityCheckClusterReport(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 = ShowSecurityCheckClusterReportRequest() request.report_id = "{report_id}" response = client.show_security_check_cluster_report(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.ShowSecurityCheckClusterReportRequest{} request.ReportId = "{report_id}" response, err := client.ShowSecurityCheckClusterReport(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
请求已成功 |
错误码
请参见错误码。