Updated on 2025-09-30 GMT+08:00

Adding an Image to the Whitelist

Function

This API is used to add an image to the whitelist. Currently, only the vulnerability whitelist is supported.

Calling Method

For details, see Calling APIs.

URI

POST /v5/{project_id}/image/whitelists

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.

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

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

vul_type

No

String

Definition

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

Constraints

N/A

Range

  • linux_vul: Linux vulnerability

  • app_vul: application vulnerability

Default Value

N/A

vul_ids

No

Array of strings

Vulnerability ID list (used only when a vulnerability whitelist is added)

rule_type

Yes

String

Definition

Whitelist rule type.

Constraints

N/A

Range

  • all_images: The whitelist is applied to all images.

  • specific_image_types: The whitelist is applied to the specified image types (only supported for specified repository types).

  • specific_images: The whitelist is applied to the specified images.

Default Value

N/A

query_info

No

query_info object

Specifying an image based on the image query criteria

image_info

No

Array of image_info objects

Specified image

description

No

String

Description of the whitelist.

Table 5 query_info

Parameter

Mandatory

Type

Description

image_type

No

String

Definition

Image type.

Constraints

N/A

Range

  • private_image: private image repository

  • shared_image: shared image repository

  • instance_image: enterprise repository

  • harbor: Harbor repository

  • jfrog: JFrog repository

Default Value

N/A

Table 6 image_info

Parameter

Mandatory

Type

Description

id

No

Long

Definition

Repository image ID

Constraints

N/A

Range

Minimum value: 1; maximum value: 9223372036854775807

Default Value

N/A

image_id

No

String

Definition

Local image ID

Constraints

N/A

Range

Length: 0 to 64 characters

Default Value

N/A

image_name

No

String

Definition

Image name.

Constraints

N/A

Range

Length: 1 to 256 characters

Default Value

N/A

image_type

No

String

Definition

Image type.

Constraints

N/A

Range

  • local_image: local image

  • private_image: private image repository

  • shared_image: shared image repository

  • instance_image: enterprise repository

  • harbor: Harbor repository

  • jfrog: JFrog repository

Default Value

N/A

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

None

Example Responses

None

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

    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();
        AddImageWhiteListsRequest request = new AddImageWhiteListsRequest();
        AddImageWhiteListsRequestBody body = new AddImageWhiteListsRequestBody();
        request.withBody(body);
        try {
            AddImageWhiteListsResponse response = client.addImageWhiteLists(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
# 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 = AddImageWhiteListsRequest()
        request.body = AddImageWhiteListsRequestBody(
        )
        response = client.add_image_white_lists(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
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.AddImageWhiteListsRequest{}
	request.Body = &model.AddImageWhiteListsRequestBody{
	}
	response, err := client.AddImageWhiteLists(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.