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

Creating a Scan Task

Function

Creating a scan job

Calling Method

For details, see Calling APIs.

URI

POST /v5/{project_id}/image/image-scan/tasks

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

No

String

Definition

Image type.

Constraints

N/A

Range

  • local_image: local image

  • registry: repository image

Default Value

registry

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

region

No

String

Definition

Region ID, which is used to query assets in the required region. For details about how to obtain a region ID, see Obtaining a Region ID.

Constraints

N/A

Range

The value can contain 1 to 128 characters.

Default Value

N/A

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

scan_scope

No

Integer

Definition

Risk type

Constraints

N/A

Range

  • 0: none

  • 0x7fffffff: all

  • 0x000f0000: vulnerability

  • 0x0000f000: baseline check

  • 0x00000f00: malicious file

  • 0x000000f0: sensitive information

  • 0x0000000f: software compliance

Default Value

N/A

rate_limit

No

Integer

Definition

Scan speed limit (unit: images/hour)

Constraints

N/A

Range

0 to 1000. The value 0 indicates no limit.

Default Value

N/A

is_all

No

Boolean

Definition

Scan all images.

Constraints

N/A

Range

  • true: All images are scanned.

  • false: Specified images are scanned. For details, see the image_info field.

Default Value

N/A

query_info

No

query_info object

Scanning based on the query result

image_info

No

Array of image_info objects

Image to be scanned

Table 5 query_info

Parameter

Mandatory

Type

Description

local_image_type

No

String

Definition

Local image type

Constraints

N/A

Range

  • swr_image: SWR image

  • other_image: other image

Default Value

N/A

host_id

No

String

Definition

Server ID

Constraints

N/A

Range

The value can contain 0 to 128 characters.

Default Value

N/A

host_name

No

String

Definition

Server Name

Constraints

N/A

Range

The value can contain 0 to 128 characters.

Default Value

N/A

public_ip

No

String

Definition

Server EIP.

Constraints

N/A

Range

The value can contain 0 to 128 characters.

Default Value

N/A

private_ip

No

String

Definition

New Private IP Address

Constraints

N/A

Range

The value can contain 0 to 128 characters.

Default Value

N/A

cluster_id

No

String

Definition

Cluster ID.

Constraints

N/A

Range

The value can contain 0 to 128 characters.

Default Value

N/A

container_id

No

String

Definition

Container ID

Constraints

N/A

Range

The value can contain 0 to 128 characters.

Default Value

N/A

container_name

No

String

Definition

Container name

Constraints

N/A

Range

The value can contain 0 to 128 characters.

Default Value

N/A

pod_id

No

String

Definition

pod id

Constraints

N/A

Range

The value contains 0 to 64 characters.

Default Value

N/A

pod_name

No

String

Definition

POD name

Constraints

N/A

Range

The value contains 0 to 512 characters.

Default Value

N/A

app_name

No

String

Definition

Software name.

Constraints

N/A

Range

The value contains 0 to 256 characters.

Default Value

N/A

has_vul

No

Boolean

Definition

Whether there are software vulnerabilities

Constraints

N/A

Range

  • true: A software vulnerability exists.

  • false: No software vulnerability exists.

Default Value

N/A

namespace

No

String

Definition

Organization

Constraints

N/A

Range

The value contains 0 to 256 characters.

Default Value

N/A

image_name

No

String

Definition

Image

Constraints

N/A

Range

The value contains 0 to 256 characters.

Default Value

N/A

image_version

No

String

Definition

Image tag.

Constraints

N/A

Range

The value contains 0 to 256 characters.

Default Value

N/A

image_type

No

String

Definition

Image type.

Constraints

N/A

Range

  • private_image: SWR private image repository

  • shared_image: SWR shared image repository

  • instance_image: SWR enterprise repository

  • harbor: Harbor repository

  • jfrog: JFrog repository

Default Value

N/A

scan_status

No

String

Definition

Scan status

Constraints

N/A

Range

  • unscan: not scanned

  • success: The scan is complete.

  • scanning: scanning

  • failed: The scan failed.

  • download_failed: The download failed.

  • image_oversized: The image is too large.

Default Value

N/A

image_size

No

Long

Definition

Image size

Constraints

N/A

Range

Value range: 0 to 9223372036854775807.

Default Value

N/A

start_latest_update_time

No

Long

Definition

Creation start date, in ms.

Constraints

N/A

Range

Value range: 0 to 9223372036854775807.

Default Value

N/A

end_latest_update_time

No

Long

Definition

Creation end date, in ms.

Constraints

N/A

Range

Value range: 0 to 9223372036854775807.

Default Value

N/A

start_latest_scan_time

No

Long

Definition

The start time of latest scan completion, in ms.

Constraints

N/A

Range

Value range: 0 to 9223372036854775807.

Default Value

N/A

end_latest_scan_time

No

Long

Definition

End date of the latest scan completion time, in ms.

Constraints

N/A

Range

Value range: 0 to 9223372036854775807.

Default Value

N/A

Table 6 image_info

Parameter

Mandatory

Type

Description

id

No

Long

id

image_id

No

String

image id

image_digest

No

String

Image digest.

registry_id

No

String

Image repository ID.

registry_name

No

String

Image repository name.

image_name

No

String

Image name

image_version

No

String

Image version

namespace

No

String

Namespaces

instance_id

No

String

Enterprise instance ID

instance_url

No

String

Downloading the enterprise image URL

registry_type

No

String

Definition

Image repository type.

Constraints

N/A

Range

  • SwrPrivate: SWR private repository

  • SwrShared: SWR shared repository

  • SwrEnterprise: SWR enterprise repository

  • Harbor: Harbor repository

  • Jfrog: JFrog repository

  • Other: other 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 CreateManualImageScanTaskSolution {

    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();
        CreateManualImageScanTaskRequest request = new CreateManualImageScanTaskRequest();
        CreateManualImageScanTaskReqInfo body = new CreateManualImageScanTaskReqInfo();
        request.withBody(body);
        try {
            CreateManualImageScanTaskResponse response = client.createManualImageScanTask(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 = CreateManualImageScanTaskRequest()
        request.body = CreateManualImageScanTaskReqInfo(
        )
        response = client.create_manual_image_scan_task(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.CreateManualImageScanTaskRequest{}
	request.Body = &model.CreateManualImageScanTaskReqInfo{
	}
	response, err := client.CreateManualImageScanTask(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.