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

Obtaining the Scan Task List

Function

This API is used to obtain the scan task list.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/image/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: local image

  • registry: repository image

Default Value

N/A

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

type

Yes

String

Definition

General task type.

Constraints

N/A

Range

  • image_sync: image synchronization

  • image_scan: image scan

Default Value

N/A

task_type

No

String

Definition

Specific task type.

Constraints

N/A

Range

  • cycle: scheduled scan

  • manual: manual scan

  • autoSync: scheduled synchronization

  • manualSync: manual synchronization

Default Value

N/A

task_name

No

String

Definition

Task name fuzzy match.

Constraints

N/A

Range

Length: 1 to 256 characters

Default Value

N/A

task_id

No

String

Definition

Job ID.

Constraints

N/A

Range

Length: 1 to 256 characters

Default Value

N/A

create_time

No

Long

Definition

Task creation time, in milliseconds.

Constraints

N/A

Range

Minimum value: 0; maximum value: 4070880000000

Default Value

N/A

end_time

No

Long

Definition

Task end time, in milliseconds.

Constraints

N/A

Range

Minimum value: 0; maximum value: 4070880000000

Default Value

N/A

task_status

No

String

Definition

Tasks

Constraints

N/A

Range

  • scanning: scanning

  • finished: completed

Default Value

N/A

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

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

data_list

Array of ImageScanTaskInfo objects

Definition

Task list

Range

Minimum value: 0; maximum value: 1000

total_num

Integer

Definition

Total tasks

Range

Minimum value: 0; maximum value: 1000

Table 5 ImageScanTaskInfo

Parameter

Type

Description

task_id

String

Definition

Task ID

Range

Length: 1 to 256 characters

policy_id

String

Definition

Policy ID.

Range

Length: 1 to 256 characters

task_name

String

Definition

Task Name

Range

Length: 1 to 256 characters

begin_time

Long

Definition

Started

Range

Minimum value: 0; maximum value: 9223372036854775807

end_time

Long

Definition

Ended

Range

Minimum value: 0; maximum value: 9223372036854775807

remain_min

Long

Definition

Remaining time of a task.

Range

Minimum value: 0; maximum value: 2147483547

task_type

String

Definition

Specific task type.

Range

  • cycle: scheduled scan.

  • manual: manual scan.

  • autoSync: scheduled synchronization.

  • manualSync: manual synchronization.

image_type

String

Definition

Image type.

Range

  • local: local image.

  • registry: repository image.

task_status

Integer

Definition

Scan progress status.

Range

  • 100: The scan is complete.

  • 0-100: scan progress.

  • -1: The scan is terminated.

  • -2: The scan times out.

  • -3: The scan is abnormal.

scan_scope

Integer

Definition

Risk type

Range

  • 0: none.

  • 0x7fffffff: all.

  • 0x000f0000: vulnerability.

  • 0x0000f000: baseline check.

  • 0x00000f00: malicious file.

  • 0x000000f0: sensitive information.

  • 0x0000000f: software compliance.

rate_limit

Integer

Definition

Scan speed limit (unit: images/hour)

Range

Minimum value: 0; maximum value: 1000

is_all

Boolean

Definition

Scan all images.

Range

  • true: All images are scanned.

  • false: Scan specified images.

failed_num

Integer

Definition

Number of images that fail to be scanned

Range

Minimum value: 0; maximum value: 2147483547

success_num

Integer

Definition

Number of images that are successfully scanned

Range

Minimum value: 0; maximum value: 2147483547

total_num

Integer

Definition

Total number of images associated with a task.

Range

Minimum value: 0; maximum value: 2147483547

risky_num

Integer

Definition

Total number of images with vulnerability risks, baseline risks, and malicious files

Range

Minimum value: 0; maximum value: 2147483547

sync_task_type

String

Definition

Synchronization task type.

Range

Length: 1 to 256 characters

failed_reason

String

Definition

reason

Range

Length: 0 to 128 characters

failed_images

Array of failed_images objects

Definition

List of failed images.

Range

Minimum value: 0; maximum value: 2147483547

Table 6 failed_images

Parameter

Type

Description

id

Long

Definition

ID of the failed image.

Range

Minimum value: 0; maximum value: 9223372036854775807

registry_id

String

Definition

Image repository ID.

Range

Length: 0 to 128 characters

registry_name

String

Definition

Image repository name.

Range

Length: 0 to 128 characters

image_name

String

Definition

Image name.

Range

Length: 0 to 128 characters

image_version

String

Definition

Image tag.

Range

Length: 0 to 128 characters

namespace

String

Definition

Namespace

Range

Length: 0 to 128 characters

registry_type

String

Definition

Image repository type.

Range

  • SwrPrivate: SWR private repository

  • SwrShared: SWR shared repository

  • SwrEnterprise: SWR enterprise repository

  • Harbor: Harbor repository

  • Jfrog: JFrog repository

  • Other: other repository

failed_reason

String

Definition

reason

Range

Length: 0 to 128 characters

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "data_list" : [ {
    "task_id" : "d5ceaaf4-0124-4f15-b039-b8fc4b07e340",
    "task_name" : "AutomaticImageAssetSynchronization_1755536448006",
    "begin_time" : 1755536448006,
    "end_time" : 1755536451911,
    "task_type" : "autoSync",
    "task_status" : 100,
    "failed_num" : 0,
    "success_num" : 3,
    "total_num" : 3,
    "failed_images" : [ ]
  } ],
  "total_num" : 1
}

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

    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();
        ListImageScanTaskRequest request = new ListImageScanTaskRequest();
        try {
            ListImageScanTaskResponse response = client.listImageScanTask(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 = ListImageScanTaskRequest()
        response = client.list_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
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.ListImageScanTaskRequest{}
	response, err := client.ListImageScanTask(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.