Help Center/ Host Security Service/ API Reference/ API Description/ Container Image/ Querying Image Vulnerability Information
Updated on 2024-07-04 GMT+08:00

Querying Image Vulnerability Information

Function

This API is used to query image vulnerability information.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/image/{image_id}/vulnerabilities

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Minimum: 1

Maximum: 256

image_id

Yes

String

Image ID

Minimum: 0

Maximum: 128

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Enterprise project ID. To query all enterprise projects, set this parameter to all_granted_eps.

Default: 0

Minimum: 1

Maximum: 256

image_type

Yes

String

Image type. The options are as follows:

  • private_image: private image repository

  • shared_image: shared image repository

Minimum: 1

Maximum: 32

offset

No

Integer

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

Minimum: 0

Maximum: 2000000

Default: 0

limit

No

Integer

Number of records on each page

Minimum: 10

Maximum: 200

Default: 10

instance_id

No

String

Enterprise repository instance ID. This API is not required for SWR shared edition.

Minimum: 0

Maximum: 128

namespace

Yes

String

Organization name

Minimum: 0

Maximum: 64

image_name

Yes

String

Image name

Minimum: 0

Maximum: 128

tag_name

Yes

String

Image tag

Minimum: 0

Maximum: 64

repair_necessity

No

String

Risk level. The options are as follows:

  • immediate_repair: high risk

  • delay_repair: medium risk

  • not_needed_repair: low risk

Minimum: 0

Maximum: 32

vul_id

No

String

Vulnerability ID (fuzzy search supported)

Minimum: 0

Maximum: 64

app_name

No

String

Software

Minimum: 0

Maximum: 64

type

No

String

Vulnerability type. The options are as follows: -linux_vul: Linux vulnerability -app_vul: application vulnerability

Minimum: 0

Maximum: 32

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

Minimum: 1

Maximum: 32768

region

No

String

Region ID

Minimum: 0

Maximum: 128

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_num

Integer

Total number of image vulnerabilities

Minimum: 0

Maximum: 2147483547

data_list

Array of ImageVulInfo objects

Image vulnerability list

Array Length: 0 - 10241

Table 5 ImageVulInfo

Parameter

Type

Description

vul_id

String

Vulnerability ID

Minimum: 0

Maximum: 128

repair_necessity

String

Emergency level. Its values and their meanings are as follows:

  • immediate_repair: high risk

  • delay_repair: medium risk

  • not_needed_repair: low risk

Minimum: 0

Maximum: 128

description

String

Vulnerability description

Minimum: 0

Maximum: 128

position

String

Image where a vulnerability exists

Minimum: 0

Maximum: 128

app_name

String

Vulnerability software name

Minimum: 0

Maximum: 128

app_path

String

Path of the application software (This field is available only for application vulnerabilities.)

Minimum: 1

Maximum: 512

version

String

Software version

Minimum: 0

Maximum: 128

solution

String

Solution

Minimum: 0

Maximum: 256

url

String

Patch address

Minimum: 0

Maximum: 128

Example Requests

Query the vulnerability information of the private image whose namespace is scc_hss_container, image name is apptest, and image version is V1.

GET https://{endpoint}/v5/{project_id}/image/{image_id}/vulnerabilities?limit=10&offset=0&namespace=scc_hss_container&tag_name=v1&image_name=apptest&image_type=private_image&type=linux_vul&enterprise_project_id=all_granted_eps

Example Responses

Status code: 200

Image vulnerability list

{
  "total_num" : 1,
  "data_list" : [ {
    "app_name" : "xz-lib",
    "description" : "online",
    "position" : "sha256:74ddd0ec08fa43dXXXX",
    "repair_necessity" : "delay_repair",
    "solution" : "To upgrade the affected software",
    "url" : "https://access.redhat.com/errata/RHSAXXX",
    "version" : "5.2.4-3.el8",
    "vul_id" : "RHSA-2022:49XX"
  } ]
}

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
48
49
50
51
52
53
54
55
56
57
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 ListImageVulnerabilitiesSolution {

    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");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        HssClient client = HssClient.newBuilder()
                .withCredential(auth)
                .withRegion(HssRegion.valueOf("<YOUR REGION>"))
                .build();
        ListImageVulnerabilitiesRequest request = new ListImageVulnerabilitiesRequest();
        request.withEnterpriseProjectId("<enterprise_project_id>");
        request.withImageType("<image_type>");
        request.withOffset(<offset>);
        request.withLimit(<limit>);
        request.withInstanceId("<instance_id>");
        request.withNamespace("<namespace>");
        request.withImageName("<image_name>");
        request.withTagName("<tag_name>");
        request.withRepairNecessity("<repair_necessity>");
        request.withVulId("<vul_id>");
        request.withAppName("<app_name>");
        request.withType("<type>");
        try {
            ListImageVulnerabilitiesResponse response = client.listImageVulnerabilities(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
33
34
35
36
37
38
39
40
41
42
# 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"]

    credentials = BasicCredentials(ak, sk)

    client = HssClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(HssRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListImageVulnerabilitiesRequest()
        request.enterprise_project_id = "<enterprise_project_id>"
        request.image_type = "<image_type>"
        request.offset = <offset>
        request.limit = <limit>
        request.instance_id = "<instance_id>"
        request.namespace = "<namespace>"
        request.image_name = "<image_name>"
        request.tag_name = "<tag_name>"
        request.repair_necessity = "<repair_necessity>"
        request.vul_id = "<vul_id>"
        request.app_name = "<app_name>"
        request.type = "<type>"
        response = client.list_image_vulnerabilities(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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
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")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := hss.NewHssClient(
        hss.HssClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListImageVulnerabilitiesRequest{}
	enterpriseProjectIdRequest:= "<enterprise_project_id>"
	request.EnterpriseProjectId = &enterpriseProjectIdRequest
	request.ImageType = "<image_type>"
	offsetRequest:= int32(<offset>)
	request.Offset = &offsetRequest
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	instanceIdRequest:= "<instance_id>"
	request.InstanceId = &instanceIdRequest
	request.Namespace = "<namespace>"
	request.ImageName = "<image_name>"
	request.TagName = "<tag_name>"
	repairNecessityRequest:= "<repair_necessity>"
	request.RepairNecessity = &repairNecessityRequest
	vulIdRequest:= "<vul_id>"
	request.VulId = &vulIdRequest
	appNameRequest:= "<app_name>"
	request.AppName = &appNameRequest
	typeRequest:= "<type>"
	request.Type = &typeRequest
	response, err := client.ListImageVulnerabilities(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

Image vulnerability list

Error Codes

See Error Codes.