文档首页/ 企业主机安全 HSS/ API参考/ API说明/ IAC风险/ 获取iac文件列表 - ListIacFiles
更新时间：2025-10-31 GMT+08:00
查看PDF
分享

获取iac文件列表 - ListIacFiles

功能介绍

获取iac文件列表

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v5/{project_id}/container/iac/files

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

参数解释:

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

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

约束限制:

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

取值范围:

字符长度1-256位

默认取值:

0，表示默认企业项目（default）。

offset

是

Integer

参数解释:

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

约束限制:

不涉及

取值范围:

最小值0，最大值2000000

默认取值:

不涉及

limit

是

Integer

参数解释:

每页显示个数

约束限制:

不涉及

取值范围:

取值10-200

默认取值:

10

scan_type

是

String

参数解释:

扫描方式

约束限制:

不涉及

取值范围:

  • manual_scan：手动扫描

  • cicd_scan：cicd扫描

默认取值:

不涉及

file_id

否

String

参数解释:

文件ID

约束限制:

不涉及

取值范围:

字符长度1-64

默认取值:

不涉及

file_name

否

String

参数解释:

文件名称

约束限制:

不涉及

取值范围:

字符长度1-512

默认取值:

不涉及

file_type

否

String

参数解释:

文件类型

约束限制:

不涉及

取值范围:

  • dockerfile：Dockerfile文件

  • k8s_yaml：k8s yaml文件

默认取值:

不涉及

risky

否

Boolean

参数解释:

是否有风险

约束限制:

不涉及

取值范围:

  • true：有风险

  • false：无风险

默认取值:

不涉及

cicd_id

否

String

约束限制:

不涉及

取值范围:

字符长度1-128

默认取值:

不涉及

cicd_name

否

String

参数解释:

CI/CD名称

约束限制:

不涉及

取值范围:

字符长度1-128

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

total_num

Integer

文件总数

data_list

Array of data_list objects

IAC文件列表
表5 data_list

参数

参数类型

描述

file_id

String

参数解释:

文件ID

约束限制:

不涉及

取值范围:

字符长度1-64

默认取值:

不涉及

file_name

String

参数解释:

文件名称

约束限制:

不涉及

取值范围:

字符长度1-512

默认取值:

不涉及

file_type

String

参数解释:

文件类型

约束限制:

不涉及

取值范围:

  • dockerfile：Dockerfile文件

  • k8s_yaml：k8s yaml文件

默认取值:

不涉及

risky

Boolean

参数解释:

是否有风险

约束限制:

不涉及

取值范围:

  • true：有风险

  • false：无风险

默认取值:

不涉及

risk_num

Integer

风险项数量

first_scan_time

Long

首次扫描时间

last_scan_time

Long

最近扫描时间

upload_file_time

Long

上传文件时间

cicd_id

String

参数解释:

cicd标识

约束限制:

不涉及

取值范围:

字符长度1-128

默认取值:

不涉及

cicd_name

String

参数解释:

CI/CD名称

约束限制:

不涉及

取值范围:

字符长度1-128

默认取值:

不涉及

scan_type

String

参数解释:

扫描方式

约束限制:

不涉及

取值范围:

  • manual_scan：手动扫描

  • cicd_scan：cicd扫描

默认取值:

不涉及

请求示例

无

响应示例

状态码：200

请求已成功

{
  "total_num" : 4,
  "data_list" : [ {
    "file_id" : "d8xxxx05-8xx5-4xx0-9xx6-c3dbxxxxxxac",
    "file_name" : "fileName",
    "file_type" : "k8s_yaml",
    "risky" : true,
    "risk_num" : 10,
    "first_scan_time" : 1745311451000,
    "last_scan_time" : 1745311451000,
    "upload_file_time" : 1745311451000
  } ]
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

父主题： IAC风险

相关文档