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

获取iac文件风险路径列表 - ListIacFileRiskPaths

功能介绍

获取iac文件风险路径列表

授权信息

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

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

URI

GET /v5/{project_id}/container/iac/file/risk/paths

表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

file_id

String

参数解释:

文件ID

约束限制:

不涉及

取值范围:

字符长度1-64

默认取值:

不涉及

rule_id

String

参数解释:

风险检测规则ID

约束限制:

不涉及

取值范围:

字符长度1-64

默认取值:

不涉及

resource_name

String

资源名称

resource_type

String

资源类型

namespace

String

资源所属的命名空间

请求参数

表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

文件风险路径列表

表5 data_list

参数

参数类型

描述

resource_name

String

资源名称

resource_type

String

资源类型

namespace

String

资源所属的命名空间

hit_rule

String

风险命中的规则

hit_path

String

存在风险的路径

请求示例

响应示例

状态码:200

请求已成功

{
  "total_num" : 1,
  "data_list" : [ {
    "resource_name" : "kube-apiserver-ecs-gph-k8s-master",
    "resource_type" : "Pod",
    "namespace" : "kube-system",
    "hit_rule" : "The API server container gphtest has insecure-port flag enabled",
    "hit_path" : "spec.containers[0].command[1]"
  } ]
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档