Help Center/ Host Security Service/ API Reference/ API Description/ Vulnerability management/ Querying Information About Containers Affected by a Vulnerability
Updated on 2025-08-15 GMT+08:00

Querying Information About Containers Affected by a Vulnerability

Function

This API is used to query information about containers affected by a single vulnerability.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/vulnerability/containers

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.

vul_id

Yes

String

Vulnerability ID

type

Yes

String

Vulnerability type

  • linux_vul: Linux vulnerability

  • windows_vul: Windows vulnerability

  • web_cms: Web-CMS vulnerabilities

  • app_vul: application vulnerabilities

  • urgent_vul: emergency vulnerabilities

container_name

No

String

Affected container

cluster_id

No

String

Cluster ID.

status

No

String

Vulnerability status. The options are as follows:

  • vul_status_unfix: not fixed

  • vul_status_ignored: ignored

  • vul_status_verified: verification in progress

  • vul_status_fixing: The fix is in progress.

  • vul_status_fixed: The fix succeeded.

  • vul_status_reboot: Fixed and pending restart

  • vul_status_failed: The fix failed.

  • vul_status_fix_after_reboot: Restart the server and try again.

handle_status

No

String

Handling status. It can be:

  • unhandled

  • handled

severity_level

No

String

Risk level. The value can be Critical, High, Medium, or Low.

min_scan_time

No

Long

Minimum first scan time

max_scan_time

No

Long

Maximum first scan time

limit

No

Integer

Number of records on each page.

offset

No

Integer

Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0.

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

Total number of affected containers

data_list

Array of VulContainerInfo objects

List of affected containers

Table 5 VulContainerInfo

Parameter

Type

Description

container_id

String

ID of the container affected by the vulnerability

container_name

String

Affected container

severity_level

String

Risk Level

  • Critical: The CVSS score of the vulnerability is greater than or equal to 9, corresponding to the high risk level on the console.

  • High: The CVSS score of the vulnerability is greater than or equal to 7 and less than 9, corresponding to the medium risk level on the console.

  • Medium: The CVSS score of the vulnerability is greater than or equal to 4 and less than 7, corresponding to the medium risk level on the console.

  • Low: The CVSS score of the vulnerability is less than 4, corresponding to the low risk level on the console.

cluster_id

String

ID of the cluster where the container affected by the vulnerability is located

cluster_name

String

Name of the cluster where the affected container is located

image_id

String

ID of the image corresponding to the container affected by the vulnerability

image_name

String

Name of the image corresponding to the affected container

image_version

String

Image version

image_type

String

Image type

image_org

String

Organization

registry_type

String

Repository type

registry_name

String

Repository name

host_name

String

Name of the host where the affected container is located

status

String

Vulnerability status. The options are as follows:

  • vul_status_unfix: not fixed

  • vul_status_ignored: ignored

  • vul_status_verified: verification in progress

  • vul_status_fixing: repairing

  • vul_status_fixed: The fix succeeded.

  • vul_status_reboot: Fixed and pending restart

  • vul_status_failed: The fix failed.

  • vul_status_fix_after_reboot: Restart the server and try again.

host_ip

String

Server public IP address

private_ip

String

Server private IP address

remark

String

Description of the handling operation

first_scan_time

Long

First scanned

scan_time

Long

Scanning time, in ms.

Example Requests

None

Example Responses

Status code: 200

Container information affected by the vulnerability

{
  "data_list" : [ {
    "container_id" : "ffd01b3365c2b422631b64f34f2175374712f744e0530b954eec8a2690a998dd",
    "container_name" : "wizardly_zhukovsky",
    "severity_level" : "Critical",
    "cluster_id" : "4ab5e1f3-69ac-40bc-9fc3-099f093334c2",
    "cluster_name" : "cyl-test-cluster",
    "image_id" : "563a0a23-6d2c-43a9-acae-b96d59192f6e",
    "image_name" : "swr.cn-north-7.myhuaweicloud.com/scc_hss_container/weblogic",
    "image_version" : "12.2.1.3-2018",
    "image_type" : "swr_image",
    "image_org" : "scc_hss_container",
    "registry_type" : "SwrPrivate",
    "registry_name" : "private",
    "host_name" : "test_host",
    "status" : "vul_status_unfix",
    "public_ip" : "100.85.217.247",
    "private_ip" : "192.168.0.148",
    "first_scan_time" : 1746841758965,
    "scan_time" : 1747021262000
  } ],
  "total_num" : 2
}

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

    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();
        ListVulContainersRequest request = new ListVulContainersRequest();
        try {
            ListVulContainersResponse response = client.listVulContainers(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 = ListVulContainersRequest()
        response = client.list_vul_containers(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.ListVulContainersRequest{}
	response, err := client.ListVulContainers(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

Container information affected by the vulnerability

Error Codes

See Error Codes.