文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 容器镜像/ 查询镜像的不合规软件信息 - ListImageNonCompliantApp
更新时间:2025-10-31 GMT+08:00
分享

查询镜像的不合规软件信息 - ListImageNonCompliantApp

功能介绍

查询镜像的不合规软件信息,若镜像类型为cicd镜像,则需传参镜像类型和镜像id唯一确定一条cicd镜像信息;若镜像类型为其他镜像仓类型,需要传参镜像类型、组织名称、镜像名称、镜像版本名称唯一确定一条其他镜像信息。

授权信息

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

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

URI

GET /v5/{project_id}/image/{image_id}/non-compliant-app

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

image_id

String

参数解释:

镜像id

约束限制:

不涉及

取值范围:

字符长度0-65535位

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

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

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

约束限制:

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

取值范围:

字符长度1-256位

默认取值:

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

limit

Integer

参数解释:

每页显示个数

约束限制:

不涉及

取值范围:

取值10-200

默认取值:

10

offset

Integer

参数解释:

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

约束限制:

不涉及

取值范围:

最小值0,最大值2000000

默认取值:

默认为0

image_type

String

参数解释:

镜像类型

约束限制:

不涉及

取值范围:

  • private_image:SWR私有镜像。

  • shared_image:SWR共享镜像。

  • instance_image:SWR企业版镜像。

  • cicd : cicd镜像。

  • harbor :Harbor仓库镜像。

默认取值:

不涉及

namespace

String

参数解释:

组织名称

约束限制:

不涉及

取值范围:

字符长度0-65535位

默认取值:

不涉及

image_name

String

参数解释:

镜像名称

约束限制:

不涉及

取值范围:

字符长度0-65535位

默认取值:

不涉及

image_version

String

参数解释:

镜像版本名称

约束限制:

不涉及

取值范围:

字符长度0-65535位

默认取值:

不涉及

app_name

String

参数解释:

不合格的软件名称

约束限制:

不涉及

取值范围:

字符长度0-65535位

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

region

String

参数解释:

区域ID,用于查询目的区域内的资产。获取方式请参见获取区域ID

约束限制:

不涉及

取值范围:

字符长度1-128位

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total_num

Integer

参数解释:

总数

取值范围:

最小值0,最大值2147483547

data_list

Array of ImageNonCompliantAppInfo objects

参数解释:

镜像的不合规软件信息

取值范围:

最小值0,最大值10241

表5 ImageNonCompliantAppInfo

参数

参数类型

描述

id

String

参数解释:

id

取值范围:

字符长度0-128位

app_name

String

参数解释:

不合规软件名称

取值范围:

字符长度0-128位

app_path

String

参数解释:

不合规软件路径

取值范围:

字符长度0-128位

app_version

String

参数解释:

不合规软件版本

取值范围:

字符长度0-64位

layer_digest

String

参数解释:

层digest

取值范围:

字符长度0-128位

请求示例

  • 查询私有镜像的不合规软件信息

    GET https://{endpoint}/v5/{project_id}/image/{image_id}/non-compliant-app?offset=0&limit=200&image_type=private_image&namespace=scc_hss_container&image_name=proxy-agent&image_version=24.5.0-x86_64&enterprise_project_id=all_granted_eps
  • 查询cicd镜像中镜像id为111的不合规软件信息

    GET https://{endpoint}/v5/{project_id}/image/111/non-compliant-app?offset=0&limit=200&image_type=cicd&enterprise_project_id=all_granted_eps

响应示例

状态码:200

请求已成功

{
  "total_num" : 1,
  "data_list" : [ {
    "app_name" : "readelf",
    "app_path" : "/usr/bin/readelf",
    "app_version" : "2.23.52.0.1-55",
    "layer_digest" : "sha256:bbfa5775dc0658fde7d5e85d6cb7646f106fa04de36e142653f237eefd120b4f"
  } ]
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档