文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 通用任务模块/ 查询当前任务关联的资源列表
更新时间:2025-08-29 GMT+08:00
分享

查询当前任务关联的资源列表

功能介绍

查询当前任务关联的资源列表

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

task_id

String

任务id

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID

如需查询所有企业项目下的资产请传参“all_granted_eps”。

约束限制:

开通企业项目功能后才需要配置企业项目ID参数。

取值范围:

字符长度1-256位

默认取值:

0,表示默认企业项目(default)。

offset

Integer

参数解释:

偏移量:指定返回记录的开始位置

约束限制:

不涉及

取值范围:

最小值0,最大值2000000

默认取值:

默认为0

limit

Integer

参数解释:

每页显示个数

约束限制:

不涉及

取值范围:

取值10-200

默认取值:

10

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

表4 请求Body参数

参数

是否必选

参数类型

描述

task_type

String

任务类型,包含如下

  • cluster_scan:集群扫描

  • iac_scan:iac扫描

cluster_scan_info

cluster_scan_info object

集群扫描任务特有的查询条件,任务类型为“cluster_scan”可用

iac_scan_info

iac_scan_info object

IAC安全扫描任务特有的查询条件,任务类型为“iac_scan”可用

表5 cluster_scan_info

参数

是否必选

参数类型

描述

scan_status

String

集群的扫描状态,包含如下:

  • scanning:扫描中

  • success:扫描成功

  • failed:扫描失败

cluster_name

String

集群名称

cluster_id

String

集群id

cluster_type

String

集群类型,包含如下:

  • cce:CCE集群

  • ali:阿里云集群

  • tencent:腾讯云集群

  • azure:微软云集群

  • aws:亚马逊集群

  • self_built_hw:华为云自建集群

  • self_built_idc:IDC自建集群

表6 iac_scan_info

参数

是否必选

参数类型

描述

scan_status

String

文件的扫描状态,包含如下:

  • scanning:扫描中

  • success:扫描成功

  • failed:扫描失败

file_name

String

文件名称

chart_name

String

chart包名称

响应参数

状态码:200

表7 响应Body参数

参数

参数类型

描述

total_num

Integer

任务关联的资源数量

cluster_scan_data_list

Array of cluster_scan_data_list objects

本次任务关联的集群扫描详情列表,任务类型为“cluster_scan”时查询结果为该列表

iac_scan_data_list

Array of iac_scan_data_list objects

本次任务关联的文件扫描详情列表,任务类型为“iac_scan”时查询结果为该列表

表8 cluster_scan_data_list

参数

参数类型

描述

cluster_name

String

集群名称

cluster_id

String

集群id

cluster_type

String

集群类型,包含如下:

  • cce:CCE集群

  • ali:阿里云集群

  • tencent:腾讯云集群

  • azure:微软云集群

  • aws:亚马逊集群

  • self_built_hw:华为云自建集群

  • self_built_idc:IDC自建集群

cluster_version

String

集群版本

scan_status

String

集群的扫描状态,包含如下:

  • scanning:扫描中

  • success:扫描成功

  • failed:扫描失败

start_time

Long

该集群扫描开始的时间

end_time

Long

该集群扫描结束的时间

scan_detail_list

Array of scan_detail_list objects

当前集群的扫描详情信息

表9 scan_detail_list

参数

参数类型

描述

scan_type

String

扫描项类型,包含如下

  • cluster_vul:集群漏洞

  • risk_assessment:风险评估

  • benchmark:安全合规

status

String

扫描状态,包含如下:

  • scanning:扫描中

  • success:扫描成功

  • failed:扫描失败

failed_reason

String

扫描失败的原因

表10 iac_scan_data_list

参数

参数类型

描述

file_name

String

文件名称

file_type

String

文件类型,包含如下

  • dockerfile:Dockerfile文件

  • k8s_yaml:k8s yaml文件

chart_name

String

chart包名称

file_id

String

文件ID,服务生成的文件唯一ID

file_size

Integer

文件大小

scan_status

String

文件的扫描状态,包含如下:

  • scanning:扫描中

  • success:扫描成功

  • failed:扫描失败

failed_reason

String

扫描失败的原因

start_time

Long

扫描开始的时间

end_time

Long

扫描结束的时间

请求示例

响应示例

SDK代码示例

SDK代码示例如下。

 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)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档