查询镜像安全配置检测结果列表 - ListImageRiskConfigs
功能介绍
查询镜像安全配置检测结果列表,当前支持检测CentOS 7、Debian 10、EulerOS和Ubuntu16镜像的系统配置项、SSH应用配置项。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/image/baseline/risk-configs
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0,表示默认企业项目(default)。 |
|
image_type |
是 |
String |
参数解释 用于筛选指定类型的镜像安全配置检测结果,不同类型对应不同镜像存储位置 约束限制 取值必须在指定范围内,否则返回空结果 取值范围 默认取值 无 |
|
offset |
否 |
Integer |
参数解释: 偏移量:指定返回记录的开始位置 约束限制: 不涉及 取值范围: 最小值0,最大值2000000 默认取值: 默认为0 |
|
limit |
否 |
Integer |
参数解释: 每页显示个数 约束限制: 不涉及 取值范围: 取值10-200 默认取值: 10 |
|
namespace |
否 |
String |
参数解释 镜像仓库的组织(命名空间)名称,用于筛选指定组织下的镜像检测结果,仅私有/共享镜像仓库有效 约束限制 仅当image_type为private_image或shared_image时有效,其他类型传参无效 取值范围 符合镜像仓库组织命名规范的字符串 默认取值 无 |
|
image_name |
否 |
String |
参数解释 镜像的名称,用于精准筛选指定名称的镜像安全配置检测结果 约束限制 支持模糊匹配(如传入'euler'可匹配所有名称含'euler'的镜像) 取值范围 符合镜像名称命名规范的字符串 默认取值 无 |
|
image_version |
否 |
String |
参数解释 镜像的版本标识,用于筛选指定版本的镜像安全配置检测结果,与image_name配合使用 约束限制 仅当指定image_name时传参有效,否则筛选条件不生效 取值范围 符合镜像版本命名规范的字符串 默认取值 无 |
|
image_id |
否 |
String |
参数解释 镜像的唯一标识,用于精准筛选指定镜像的安全配置检测结果,优先级高于image_name+image_version 约束限制 传入后将忽略image_name和image_version参数,直接按ID筛选 默认取值 无 |
|
check_name |
否 |
String |
参数解释 安全配置检测的基线名称,用于筛选指定基线的检测结果(如'CentOS 7'、'EulerOS'等) 约束限制 仅支持功能介绍中列出的系统基线(CentOS 7、Debian 10、EulerOS、Ubuntu16) 取值范围 支持的基线名称列表详见功能介绍 默认取值 无 |
|
severity |
否 |
String |
参数解释 镜像安全配置检测结果的风险等级,用于筛选指定风险等级的检测记录 约束限制 取值必须在指定范围内,否则返回空结果 取值范围 默认取值 无 |
|
standard |
否 |
String |
参数解释 安全配置检测遵循的标准,用于筛选符合指定标准的检测结果 约束限制 取值必须在指定范围内,否则返回空结果 取值范围 默认取值 无 |
|
instance_id |
否 |
String |
参数解释 华为云SWR(软件仓库)企业版实例的唯一标识,用于筛选指定企业仓库实例下的镜像检测结果 约束限制 仅当image_type为private_image且使用SWR企业版时有效,共享版/本地镜像传参无效 取值范围 SWR企业版实例ID 默认取值 无 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_num |
Integer |
参数解释 符合筛选条件的镜像安全配置检测结果总记录数 取值范围 取值0-2147483647 |
|
data_list |
Array of ImageRiskConfigsInfoResponseInfo objects |
参数解释 包含查询到的镜像安全配置检测结果详情,每个元素对应一个镜像的基线检测汇总信息 取值范围 数组长度0-limit(每页显示个数) |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
severity |
String |
参数解释 镜像安全配置检测结果的风险等级,用于筛选指定风险等级的检测记录 约束限制 取值必须在指定范围内,否则返回空结果 取值范围 默认取值 无 |
|
check_name |
String |
参数解释 安全配置检测的基线名称,用于筛选指定基线的检测结果(如'CentOS 7'、'EulerOS'等) 约束限制 仅支持功能介绍中列出的系统基线(CentOS 7、Debian 10、EulerOS、Ubuntu16) 取值范围 支持的基线名称列表详见功能介绍 默认取值 无 |
|
check_type |
String |
参数解释 用于区分基线的类型 取值范围 字符长度0-256位 |
|
standard |
String |
参数解释 安全配置检测遵循的标准,用于筛选符合指定标准的检测结果 约束限制 取值必须在指定范围内,否则返回空结果 取值范围 默认取值 无 |
|
check_rule_num |
Integer |
参数解释 该基线对应的安全配置检测总检查项数量 取值范围 取值0-2097152 |
|
failed_rule_num |
Integer |
参数解释 该基线检测中未通过(存在安全风险)的检查项数量 取值范围 取值0-2097152 |
|
check_type_desc |
String |
参数解释 该基线的详细描述,说明基线的检测目的、适用场景等信息 取值范围 字符长度0-65534位,支持中文、英文、数字、常用标点符号及空格 |
请求示例
-
查询私有镜像中命名空间为scc_hss_container,镜像名称为euleros,镜像版本为2.2的镜像安全配置检测结果列表。
GET https://{endpoint}/v5/{project_id}/image/baseline/risk-configs?offset=0&limit=200&image_type=private_image&namespace=scc_hss_container&image_name=euleros/test&image_version=2.2.6&enterprise_project_id=all_granted_eps -
查询cicd镜像中镜像id为111的镜像安全配置检测结果列表。
GET https://{endpoint}/v5/{project_id}/image/baseline/risk-configs?offset=0&limit=200&image_type=cicd&image_id=111&enterprise_project_id=all_granted_eps
响应示例
状态码:200
请求已成功
{
"total_num" : 1,
"data_list" : [ {
"check_name" : "CentOS 7",
"check_rule_num" : 3,
"check_type" : 3,
"check_type_desc" : "本规范着重于从XXX",
"failed_rule_num" : 0,
"severity" : "Low",
"standard" : "cn_standard"
} ]
}
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 ListImageRiskConfigsSolution { 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(); ListImageRiskConfigsRequest request = new ListImageRiskConfigsRequest(); try { ListImageRiskConfigsResponse response = client.listImageRiskConfigs(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 = ListImageRiskConfigsRequest() response = client.list_image_risk_configs(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.ListImageRiskConfigsRequest{} response, err := client.ListImageRiskConfigs(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。