Help Center/ Host Security Service/ API Reference/ API Description/ Container Images/ Querying Details About an Image Whitelist
Updated on 2025-09-08 GMT+08:00

Querying Details About an Image Whitelist

Function

This API is used to query details about the image whitelist. The list of images associated with the whitelist needs to be queried by page.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/image/whitelists/{id}

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

id

Yes

String

Definition

Whitelist ID

Constraints

N/A

Range

Length: 1 to 64 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

global_image_type

Yes

String

Definition

Image type.

Constraints

N/A

Range

  • local: local image

  • registry: repository image

Default Value

N/A

type

Yes

String

Definition

Whitelist type.

Constraints

N/A

Range

  • vulnerability: vulnerability whitelist

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

id

String

Definition

Whitelist ID

Range

Length: 0 to 64 characters

vul_id

String

Definition

Vulnerability ID (returned only when the vulnerability whitelist is queried)

Range

Length: 0 to 256 characters

vul_name

String

Definition

Vulnerability name (returned only when the vulnerability whitelist is queried)

Range

Length: 0 to 256 characters

vul_type

String

Definition

Vulnerability type (returned only when the vulnerability whitelist is queried)

Range

  • linux_vul: Linux vulnerability.

  • app_vul: application vulnerability.

cves

Array of cves objects

Definition

CVE list corresponding to the vulnerability (returned only when the vulnerability whitelist is queried)

Range

Minimum value: 0; maximum value: 1000

rule_type

String

Whitelist rule type. The options are as follows:

-all_images: The whitelist applies to all images.

-specific_image_types: The whitelist applies to specified image types (only to specified repository image types).

-specific_images: The whitelist applies to specified images.

query_info

query_info object

Specifies the image type when the whitelist rule is specific_image_types.

image_info

Array of image_info objects

Specifies the image list when the whitelist rule is specific_images. Data is returned only when details about the image whitelist are queried.

description

String

Definition

Description of a whitelist

Range

Length: 0 to 1024 characters

Table 5 cves

Parameter

Type

Description

cve_id

String

Definition

CVE ID

Range

Length: 0 to 256 characters

cvss

Float

Definition

CVE Score

Range

Value range: 0 to 10

Table 6 query_info

Parameter

Type

Description

image_type

String

Definition

Image type. Use commas (,) to separate multiple types.

Range

  • private_image: SWR private image repository.

  • shared_image: shared image repository of SWR.

  • instance_image: SWR enterprise repository.

  • harbor: Harbor repository.

  • jfrog: JFrog repository.

Table 7 image_info

Parameter

Type

Description

id

Long

Definition

Repository image ID

Range

Value range: 1 to 9223372036854775807

image_id

String

Definition

Local image ID.

Range

Length: 1 to 64 characters

image_name

String

Definition

Image name.

Range

Length: 1 to 256 characters

Example Requests

None

Example Responses

Status code: 200

Whitelist Details

{
  "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "vul_id" : "CESA-2011:1777",
  "vul_name" : "EulerOS-SA-2020-1102",
  "vul_type" : "linux_vul",
  "cves" : [ {
    "cve_id" : "KYSA-202201-0009",
    "cvss" : 7.9
  } ],
  "rule_type" : "specific_images",
  "query_info" : null,
  "image_info" : [ {
    "id" : 9223372036854776000,
    "image_name" : "image_name"
  } ],
  "description" : "some description"
}

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

    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();
        ShowImageWhiteListDetailRequest request = new ShowImageWhiteListDetailRequest();
        request.withId("{id}");
        try {
            ShowImageWhiteListDetailResponse response = client.showImageWhiteListDetail(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
# 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 = ShowImageWhiteListDetailRequest()
        request.id = "{id}"
        response = client.show_image_white_list_detail(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
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.ShowImageWhiteListDetailRequest{}
	request.Id = "{id}"
	response, err := client.ShowImageWhiteListDetail(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

Whitelist Details

Error Codes

See Error Codes.