查询当前任务关联的资源列表 - ListTaskResources
功能介绍
查询当前任务关联的资源列表
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
POST /v5/{project_id}/common/tasks/{task_id}/resources/batch-query
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
task_id |
是 |
String |
任务id |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID，用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0，表示默认企业项目（default）。 |
|
offset |
否 |
Integer |
参数解释: 偏移量：指定返回记录的开始位置 约束限制: 不涉及 取值范围: 最小值0，最大值2000000 默认取值: 默认为0 |
|
limit |
否 |
Integer |
参数解释: 每页显示个数 约束限制: 不涉及 取值范围: 取值10-200 默认取值: 10 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
task_type |
是 |
String |
任务类型，包含如下
|
|
cluster_scan_info |
否 |
cluster_scan_info object |
集群扫描任务特有的查询条件，任务类型为“cluster_scan”可用 |
|
iac_scan_info |
否 |
iac_scan_info object |
IAC安全扫描任务特有的查询条件，任务类型为“iac_scan”可用 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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”时查询结果为该列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
cluster_name |
String |
集群名称 |
|
cluster_id |
String |
集群id |
|
cluster_type |
String |
集群类型，包含如下：
|
|
cluster_version |
String |
集群版本 |
|
scan_status |
String |
集群的扫描状态，包含如下：
|
|
start_time |
Long |
该集群扫描开始的时间 |
|
end_time |
Long |
该集群扫描结束的时间 |
|
scan_detail_list |
Array of scan_detail_list objects |
当前集群的扫描详情信息 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
scan_type |
String |
扫描项类型，包含如下
|
|
status |
String |
扫描状态，包含如下：
|
|
failed_reason |
String |
扫描失败的原因 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
file_name |
String |
文件名称 |
|
file_type |
String |
文件类型，包含如下
|
|
chart_name |
String |
chart包名称 |
|
file_id |
String |
文件ID，服务生成的文件唯一ID |
|
file_size |
Integer |
文件大小 |
|
scan_status |
String |
文件的扫描状态，包含如下：
|
|
failed_reason |
String |
扫描失败的原因 |
|
start_time |
Long |
扫描开始的时间 |
|
end_time |
Long |
扫描结束的时间 |
请求示例
查询project_id为2b31ed520xxxxxxebedb6e57xxxxxxxx，task_id为9d4fxxxxxx034d1199xxxxc61b1bxxxx的集群扫描任务的资源列表
POST https://{endpoint}/v5/2b31ed520xxxxxxebedb6e57xxxxxxxx/common/tasks/9d4fxxxxxx034d1199xxxxc61b1bxxxx/resources/batch-query?enterprise_project_id=all_granted_eps
{
"task_type" : "cluster_scan"
}
响应示例
状态码：200
请求已成功
{
"total_num" : 1,
"cluster_scan_data_list" : [ {
"cluster_id" : "4axxxxf3-6xxc-4xxc-9xx3-099xxxxxx4c2",
"cluster_name" : "my-cluster",
"cluster_type" : "cce",
"cluster_version" : "v1.28.2",
"scan_status" : "failed",
"start_time" : 1745311451000,
"end_time" : 1745311451000,
"scan_detail_list" : [ {
"scan_type" : "cluster_vul",
"status" : "failed",
"failed_reason" : "some error message."
} ]
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。
