Help Center/ Host Security Service/ API Reference/ API Description/ Container Images/ Viewing the List of Images Affected by the Vulnerability
Updated on 2025-09-08 GMT+08:00

Viewing the List of Images Affected by the Vulnerability

Function

This API is used to view the list of images affected by vulnerabilities.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/vulnerability/images

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 1 to 256 characters.

Default Value

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Definition

Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID.

To query assets in all enterprise projects, set this parameter to all_granted_eps.

Constraints

You need to set this parameter only after the enterprise project function is enabled.

Range

The value can contain 1 to 256 characters.

Default Value

0: default enterprise project.

offset

No

Integer

Definition

Offset, which specifies the start position of the record to be returned.

Constraints

N/A

Range

The value range is 0 to 2,000,000.

Default Value

The default value is 0.

limit

No

Integer

Parameter description:

Number of records displayed on each page.

Constraints:

N/A

Options:

Value range: 10-200

Default value:

10

is_handled

Yes

Boolean

Definition

Query handled/unhandled images.

Constraints

N/A

Range

  • true: Query handled images.

  • false: Query unhandled images.

Default Value

N/A

vul_id

Yes

String

Definition

Vulnerability ID.

Constraints

N/A

Range

Length: 0 to 256 characters

Default Value

N/A

type

Yes

String

Definition

Vulnerability type.

Constraints

N/A

Range

  • app_vul: application vulnerability

  • linux_vul: system vulnerability

Default Value

N/A

image_type

Yes

String

Definition

Image type.

Constraints

N/A

Range

  • local: local image

  • registry: repository image

  • cicd: CI/CD image

  • cluster: cluster image

Default Value

N/A

repair_necessity

No

String

Definition

Severity.

Constraints

N/A

Range

  • Low: low-risk

  • Medium: medium-risk

  • High: high-risk

  • Critical: critical

Default Value

N/A

image_id

No

String

Definition

Image ID.

Constraints

N/A

Range

Length: 0 to 256 characters

Default Value

N/A

image_name

No

String

Definition

Image name.

Constraints

N/A

Range

Length: 0 to 256 characters

Default Value

N/A

registry_name

No

String

Definition

Image repository name.

Constraints

N/A

Range

Length: 0 to 256 characters

Default Value

N/A

registry_type

No

String

Definition

Image repository type.

Constraints

N/A

Range

Length: 0 to 256 characters

Default Value

N/A

status

No

String

Definition

Processing status of the image corresponding to the vulnerability.

Constraints

N/A

Range

  • vul_status_unfix: not handled

  • vul_status_ignored: ignored

Default Value

N/A

cluster_id

No

String

Definition

Cluster ID.

Constraints

N/A

Range

Length: 0 to 128 characters

Default Value

N/A

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token.

Constraints

N/A

Range

The value can contain 1 to 32,768 characters.

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_num

Integer

Definition

Total number.

Range

The value range is 0 to 2,147,483,647.

data_list

Array of VulAffectImagesResponseInfo objects

Definition

Affected images

Range

N/A

Table 5 VulAffectImagesResponseInfo

Parameter

Type

Description

image_id

String

Definition

Image ID.

Range

Length: 0 to 256 characters

image_name

String

Definition

Image name.

Range

Length: 0 to 512 characters

vul_id

String

Definition

Vulnerability ID.

Range

Length: 0 to 256 characters

repair_necessity

String

Definition

Severity.

Range

  • Low: low-risk

  • Medium: medium-risk

  • High: high-risk

  • Critical: critical

container_num

Integer

Definition

Number of associated containers

Range

Value range: 0-2147483547

image_digest

String

Definition

Image identifier.

Range

Length: 0 to 256 characters

image_version

String

Definition

Image tag.

Range

Length: 0 to 64 characters

agent_id

String

Definition

Agent ID

Range

Length: 0 to 128 characters

status

String

Definition

Vulnerability status.

Range

  • vul_status_unfix: not handled

  • vul_status_ignored: ignored

first_scan_time

String

Definition

First scan time (timestamp, in milliseconds).

Range

Length: 0 to 32 characters

latest_scan_time

String

Definition

Latest scan time (timestamp, in milliseconds).

Range

Length: 0 to 32 characters

image_type

String

Definition

Image type.

Range

  • local_image: local image

  • registry: repository image

  • cicd: CI/CD image

image_size

String

Definition

Image size

Range

Length: 0 to 128 characters

organization

String

Definition

Belongs to Organization

Range

Length: 0 to 256 characters

registry_type

String

Definition

Image repository type.

Range

  • Harbor: harbor

  • Jfrog: jfrog

  • SwrPrivate: SWR private repository

  • SwrShared: SWR shared repository

  • SwrEnterprise: SWR enterprise repository

  • Other: other repository

registry_name

String

Definition

Registry name.

Range

Length: 0 to 256 characters

is_multi_arch

String

Definition

Multi-architecture or not

Range

  • true: multi-architecture

  • false: not multi-architecture

cluster_id

String

Definition

Cluster ID.

Range

Length: 0 to 128 characters

cluster_name

String

Definition

Cluster Name

Range

Length: 0 to 256 characters

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "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 Sample Code

The SDK sample code is as follows.

 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)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.