Help Center/ Host Security Service/ API Reference/ API Description/ Common service modules/ Querying the Resource List Associated with the Current Task
Updated on 2025-08-15 GMT+08:00

Querying the Resource List Associated with the Current Task

Function

Query the resource list associated with the current task.

Calling Method

For details, see Calling APIs.

URI

POST /v5/{project_id}/common/tasks/{task_id}/resources/batch-query

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

task_id

Yes

String

Task ID.

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

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

task_type

Yes

String

Task type. The options are as follows:

  • cluster_scan

  • iac_scan

cluster_scan_info

No

cluster_scan_info object

Search criteria specific to cluster scan tasks. This parameter is available only when the task type is cluster_scan.

iac_scan_info

No

iac_scan_info object

Query criteria specific to IAC security scanning tasks. These criteria are available only when the task type is iac_scan.

Table 5 cluster_scan_info

Parameter

Mandatory

Type

Description

scan_status

No

String

Cluster scanning status. The options are as follows:

  • scanning

  • success: The scanning is successful.

  • failed

cluster_name

No

String

Cluster name

cluster_id

No

String

Cluster ID.

cluster_type

No

String

Cluster type. The options are as follows:

  • cce: CCE cluster

  • ali: Alibaba Cloud cluster

  • tencent: Tencent Cloud cluster

  • azure: Microsoft Azure Cloud cluster

  • aws: AWS Cloud cluster

  • self_built_hw: customer-built cluster on Huawei Cloud

  • self_built_idc: IDC on-premises cluster

Table 6 iac_scan_info

Parameter

Mandatory

Type

Description

scan_status

No

String

File scanning status. The options are as follows:

  • scanning

  • success

  • failed

file_name

No

String

File name

chart_name

No

String

Chart package name

Response Parameters

Status code: 200

Table 7 Response body parameters

Parameter

Type

Description

total_num

Integer

Number of resources associated with a task.

cluster_scan_data_list

Array of cluster_scan_data_list objects

List of cluster scan details associated with the task. The query result is the list when the task type is cluster_scan.

iac_scan_data_list

Array of iac_scan_data_list objects

List of file scan details associated with the task. The list is displayed when the task type is iac_scan.

Table 8 cluster_scan_data_list

Parameter

Type

Description

cluster_name

String

Cluster name

cluster_id

String

Cluster ID

cluster_type

String

Cluster type. The options are as follows:

  • cce: CCE cluster

  • ali: Alibaba Cloud cluster

  • tencent: Tencent Cloud Cluster

  • azure: Microsoft cloud cluster

  • aws: Amazon cluster

  • self_built_hw: Huawei Cloud self-built cluster

  • self_built_idc: self-built IDC cluster

cluster_version

String

Version

scan_status

String

Cluster scanning status. The options are as follows:

  • scanning

  • success

  • failed

start_time

Long

Time when the cluster scan started.

end_time

Long

Time when the cluster scan ended.

scan_detail_list

Array of scan_detail_list objects

Scan details of the current cluster

Table 9 scan_detail_list

Parameter

Type

Description

scan_type

String

Scan item type. The options are as follows:

  • cluster_vul: cluster vulnerability

  • risk_assessment: risk assessment

  • benchmark: security compliance

status

String

Scanning status. The options are as follows:

  • scanning

  • success

  • failed

failed_reason

String

Cause of the scanning failure.

Table 10 iac_scan_data_list

Parameter

Type

Description

file_name

String

File name

file_type

String

File type. The options are as follows:

  • dockerfile: Dockerfile file

  • k8s_yaml: Kubernetes YAML file

chart_name

String

Chart Package Name

file_id

String

File ID, which is the unique ID of the file generated by the service.

file_size

Integer

File size

scan_status

String

Server scan status. The options are as follows:

  • scanning

  • success

  • failed

failed_reason

String

Cause of the scanning failure.

start_time

Long

Scan start time

end_time

Long

Scan end time

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
50
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 ListTaskResourcesSolution {

    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();
        ListTaskResourcesRequest request = new ListTaskResourcesRequest();
        request.withTaskId("{task_id}");
        ListTaskResourcesRequestBody body = new ListTaskResourcesRequestBody();
        request.withBody(body);
        try {
            ListTaskResourcesResponse response = client.listTaskResources(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
# 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 = ListTaskResourcesRequest()
        request.task_id = "{task_id}"
        request.body = ListTaskResourcesRequestBody(
        )
        response = client.list_task_resources(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
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.ListTaskResourcesRequest{}
	request.TaskId = "{task_id}"
	request.Body = &model.ListTaskResourcesRequestBody{
	}
	response, err := client.ListTaskResources(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.