文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 容器镜像/ 查询镜像构建指令影响到的镜像列表 - ListImageBuildCommandRisksImages
更新时间:2025-10-31 GMT+08:00
分享

查询镜像构建指令影响到的镜像列表 - ListImageBuildCommandRisksImages

功能介绍

查询镜像构建指令影响到的镜像列表

授权信息

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

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

URI

GET /v5/{project_id}/image/build-command-risks/images

表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

默认取值:

默认为0

limit

Integer

参数解释:

每页显示个数

约束限制:

不涉及

取值范围:

取值10-200

默认取值:

10

image_type

String

参数解释:

镜像类型

约束限制:

不涉及

取值范围:

  • cicd:cicd镜像

  • registry:仓库镜像

字符长度1-32

默认取值:

不涉及

rule_id

String

参数解释:

风险检测规则ID

约束限制:

不涉及

取值范围:

字符长度1-64

默认取值:

不涉及

image_id

String

参数解释

镜像id

约束限制

不涉及

取值范围

字符长度0-128位

默认取值

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total_num

Integer

参数解释

镜像构建指令影响的镜像数据总量

取值范围

取值0-2147483547

data_list

Array of BuildCommandRisksImageResponseInfo objects

参数解释:

镜像构建指令影响的镜像列表

取值范围:

取值0-200

表5 BuildCommandRisksImageResponseInfo

参数

参数类型

描述

namespace

String

参数解释:

组织名称

取值范围:

字符长度0-64

image_digest

String

参数解释:

镜像digest

取值范围:

字符长度0-128

image_id

String

参数解释:

镜像id

取值范围:

字符长度0-128

image_name

String

参数解释:

镜像名称

取值范围:

字符长度0-128

image_version

String

参数解释:

镜像版本

取值范围:

字符长度0-128

image_type

String

参数解释:

镜像类型

取值范围:

  • private_image:私有镜像

  • shared_image:共享镜像

  • instance_image:企业镜像

  • harbor:Harbor镜像

  • jfrog:Jfrog镜像

  • cicd:cicd镜像

image_size

Long

参数解释:

版本大小

取值范围:

大小0-9223372036854775807

latest_scan_time

Long

参数解释:

最后一次检测时间,时间单位 毫秒(ms)

取值范围:

大小0-9223372036854775807

risk_detail_info

BuildCommandRiskDetailListResponseInfo object

表6 BuildCommandRiskDetailListResponseInfo

参数

参数类型

描述

risk_num

Integer

参数解释

镜像构建指令风险详情总数

取值范围

取值0-2147483547

risk_list

Array of BuildCommandRiskDetailResponseInfo objects

参数解释:

镜像构建指令风险详情列表

取值范围:

取值0-2147483647

表7 BuildCommandRiskDetailResponseInfo

参数

参数类型

描述

remediation

String

参数解释

风险的处置建议

取值范围

字符长度0-65534位

build_instruction

String

参数解释

存在风险的构建指令

取值范围

字符长度0-256位

请求示例

响应示例

状态码:200

请求已成功

{
  "total_num" : 1,
  "data_list" : [ {
    "namespace" : "library",
    "image_digest" : "sha256:xxx",
    "image_id" : "xxx",
    "image_name" : "my_image_name",
    "image_version" : "3.2.0",
    "image_type" : "private_image",
    "image_size" : 152610175,
    "latest_scan_time" : 1691748641788,
    "risk_detail_info" : {
      "risk_num" : 1,
      "risk_list" : [ {
        "build_instruction" : "--",
        "remediation" : "在Dockerfile中添加如下行:USER <non root user name>"
      } ]
    }
  } ]
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档