文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 容器镜像/ 查看受漏洞影响的镜像列表
更新时间:2025-08-29 GMT+08:00
分享

查看受漏洞影响的镜像列表

功能介绍

查看受漏洞影响的镜像列表

调用方法

请参见如何调用API

URI

GET /v5/{project_id}/vulnerability/images

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

offset

Integer

参数解释:

偏移量:指定返回记录的开始位置

约束限制:

不涉及

取值范围:

最小值0,最大值2000000

默认取值:

默认为0

limit

Integer

参数解释:

每页显示个数

约束限制:

不涉及

取值范围:

取值10-200

默认取值:

10

is_handled

Boolean

参数解释:

查询已处理/未处理的镜像

约束限制:

不涉及

取值范围:

  • true:查询已处理的镜像

  • false:查询未处理的镜像

默认取值:

不涉及

vul_id

String

参数解释:

漏洞id

约束限制:

不涉及

取值范围:

字符长度0-256位

默认取值:

不涉及

type

String

参数解释:

漏洞类型

约束限制:

不涉及

取值范围:

  • app_vul:应用漏洞

  • linux_vul:系统漏洞

默认取值:

不涉及

image_type

String

参数解释:

镜像类型

约束限制:

不涉及

取值范围:

  • local:本地镜像

  • registry:仓库镜像

  • cicd:CI/CD镜像

  • cluster:集群镜像

默认取值:

不涉及

repair_necessity

String

参数解释:

危险程度

约束限制:

不涉及

取值范围:

  • Low:低危

  • Medium:中危

  • High:高危

  • Critical:严重

默认取值:

不涉及

image_id

String

参数解释:

镜像id

约束限制:

不涉及

取值范围:

字符长度0-256位

默认取值:

不涉及

image_name

String

参数解释:

镜像名称

约束限制:

不涉及

取值范围:

字符长度0-256位

默认取值:

不涉及

registry_name

String

参数解释:

镜像仓名称

约束限制:

不涉及

取值范围:

字符长度0-256位

默认取值:

不涉及

registry_type

String

参数解释:

镜像仓类型

约束限制:

不涉及

取值范围:

字符长度0-256位

默认取值:

不涉及

status

String

参数解释:

漏洞对应镜像的处理状态

约束限制:

不涉及

取值范围:

  • vul_status_unfix:未处理

  • vul_status_ignored:已忽略

默认取值:

不涉及

cluster_id

String

参数解释:

集群id

约束限制:

不涉及

取值范围:

字符长度0-128位

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total_num

Integer

参数解释:

总数

取值范围:

取值0-2147483647

data_list

Array of VulAffectImagesResponseInfo objects

参数解释:

受漏洞影响的镜像列表

取值范围:

不涉及

表5 VulAffectImagesResponseInfo

参数

参数类型

描述

image_id

String

参数解释:

镜像id

取值范围:

字符长度0-256位

image_name

String

参数解释:

镜像名称

取值范围:

字符长度0-512位

vul_id

String

参数解释:

漏洞id

取值范围:

字符长度0-256位

repair_necessity

String

参数解释:

危险程度

取值范围:

  • Low:低危

  • Medium:中危

  • High:高危

  • Critical:严重

container_num

Integer

参数解释:

关联容器数

取值范围:

取值0-2147483547

image_digest

String

参数解释:

镜像标识

取值范围:

字符长度0-256位

image_version

String

参数解释:

镜像版本

取值范围:

字符长度0-64位

agent_id

String

参数解释:

Agent ID

取值范围:

字符长度0-128位

status

String

参数解释:

漏洞当前状态

取值范围:

  • vul_status_unfix:未处理

  • vul_status_ignored:已忽略

first_scan_time

String

参数解释:

首次扫描时间(时间戳,单位为毫秒)

取值范围:

字符长度0-32位

latest_scan_time

String

参数解释:

最近扫描时间(时间戳,单位为毫秒)

取值范围:

字符长度0-32位

image_type

String

参数解释:

镜像类型

取值范围:

  • local_image:本地镜像

  • registry:仓库镜像

  • cicd:CI/CD镜像

image_size

String

参数解释:

镜像大小

取值范围:

字符长度0-128位

organization

String

参数解释:

所属组织

取值范围:

字符长度0-256位

registry_type

String

参数解释:

镜像仓类型

取值范围:

  • Harbor:harbor

  • Jfrog:jfrog

  • SwrPrivate:swr私有

  • SwrShared:swr共享

  • SwrEnterprise:swr企业

  • Other:其他仓库

registry_name

String

参数解释:

仓库名称

取值范围:

字符长度0-256位

is_multi_arch

String

参数解释:

是否为多架构

取值范围:

  • true:是多架构

  • false:不是多架构

cluster_id

String

参数解释:

集群ID

取值范围:

字符长度0-128位

cluster_name

String

参数解释:

集群名称

取值范围:

字符长度0-256位

请求示例

响应示例

状态码:200

请求已成功

{
  "total_num" : 1,
  "data_list" : [ {
    "agent_id" : "9e74293xxxxxx94e3d0869d03989xxxxxxb27a6cbc201d9xxxxx5296xxxxxxxx",
    "image_id" : "77eaxxxx-50xx-4xxa-9cxx-c2012bxxxxb2",
    "image_name" : "swr.cn-north-4.myhuaweicloud.com/hss_container_org/hostguard",
    "vul_id" : "EulerOS-SA-2023-3326",
    "repair_necessity" : "Critical",
    "container_num" : 1,
    "image_digest" : "sha256:d5cfb6xxxxa9c1xxxx2d7a6bf326f7xxxx8b0910986xxxx89b446150xxxxb969",
    "image_version" : "3.2.20",
    "status" : "vul_status_unfix",
    "first_scan_time" : 1754563675226,
    "latest_scan_time" : 1754894967975,
    "image_type" : "local",
    "image_size" : 420717590,
    "organization" : "hss_container_org",
    "registry_type" : "SwrPrivate",
    "registry_name" : "Swr-private"
  } ]
}

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

    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();
        ListVulAffectImagesRequest request = new ListVulAffectImagesRequest();
        try {
            ListVulAffectImagesResponse response = client.listVulAffectImages(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 = ListVulAffectImagesRequest()
        response = client.list_vul_affect_images(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.ListVulAffectImagesRequest{}
	response, err := client.ListVulAffectImages(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档