文档首页> 主机安全服务（新版）HSS> API参考> API说明> 容器镜像> 本地镜像列表查询
更新时间：2024-07-04 GMT+08:00
在线调试
CLI示例
查看PDF
分享

本地镜像列表查询

功能介绍

本地镜像列表查询

调用方法

请参见如何调用API。

URI

GET /v5/{project_id}/image/local-repositories

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

最小长度：1

最大长度：256
表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

企业项目ID，查询所有企业项目时填写：all_granted_eps

缺省值：0

最小长度：1

最大长度：256

image_name

否

String

镜像名称

最小长度：1

最大长度：128

image_version

否

String

镜像版本

最小长度：1

最大长度：64

offset

否

Integer

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

最小值：0

最大值：2000000

缺省值：0

limit

否

Integer

每页显示数量

最小值：10

最大值：200

缺省值：10

scan_status

否

String

扫描状态，包含如下:

  • unscan : 未扫描

  • success : 扫描完成

  • scanning : 扫描中

  • failed : 扫描失败

  • waiting_for_scan : 等待扫描

最小长度：0

最大长度：32

local_image_type

否

String

镜像类型，包含如下:

  • other_image : 非SWR镜像

  • swr_image : SWR镜像

最小长度：0

最大长度：64

image_size

否

Long

镜像大小，单位字节

最小值：0

最大值：2147483547

缺省值：0

start_latest_update_time

否

Long

最近更新时间搜索开始日期，时间单位 毫秒（ms）

最小值：0

最大值：2147483547

缺省值：0

end_latest_update_time

否

Long

最近更新时间搜索结束日期，时间单位 毫秒（ms）

最小值：0

最大值：2147483547

缺省值：0

start_latest_scan_time

否

Long

最近一次扫描完成时间搜索开始日期，时间单位 毫秒（ms）

最小值：0

最大值：2147483547

缺省值：0

end_latest_scan_time

否

Long

最近一次扫描完成时间搜索结束日期，时间单位 毫秒（ms）

最小值：0

最大值：2147483547

缺省值：0

has_vul

否

Boolean

是否存在软件漏洞

host_name

否

String

本地镜像所关联服务器的名称

最小长度：0

最大长度：128

host_id

否

String

本地镜像所关联服务器的ID

最小长度：0

最大长度：128

host_ip

否

String

本地镜像所关联服务器的IP（公网或私网）

最小长度：0

最大长度：128

container_id

否

String

本地镜像所关联容器的ID

最小长度：0

最大长度：128

container_name

否

String

本地镜像所关联容器的名称

最小长度：0

最大长度：128

pod_id

否

String

本地镜像所关联Pod的ID

最小长度：0

最大长度：128

pod_name

否

String

本地镜像所关联Pod的名称

最小长度：0

最大长度：128

app_name

否

String

本地镜像所关联软件的名称

最小长度：0

最大长度：128

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

x-auth-token

是

String

用户Token。

最小长度：1

最大长度：32768

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

total_num

Integer

本地镜像总数

最小值：0

最大值：2147483547

data_list

Array of ImageLocalInfo objects

本地镜像数据列表

数组长度：1 - 100000
表5 ImageLocalInfo

参数

参数类型

描述

image_name

String

镜像名称

最小长度：0

最大长度：256

image_id

String

镜像ID

最小长度：0

最大长度：64

image_digest

String

镜像digest

最小长度：0

最大长度：128

image_version

String

镜像版本

最小长度：0

最大长度：256

local_image_type

String

本地镜像类型

最小长度：0

最大长度：256

scan_status

String

扫描状态，包含如下：

  • unscan：未扫描

  • success：扫描完成

  • scanning：正在扫描

  • failed：扫描失败

  • waiting：等待扫描

最小长度：0

最大长度：256

image_size

Long

镜像大小，单位字节

最小值：0

最大值：9223372036854775807

latest_update_time

Long

镜像版本最后更新时间，时间单位毫秒（ms）

最小值：0

最大值：4070880000000

latest_scan_time

Long

最近扫描时间，时间单位毫秒（ms）

最小值：0

最大值：4070880000000

vul_num

Long

漏洞个数

最小值：0

最大值：9223372036854775807

unsafe_setting_num

Long

基线扫描未通过数

最小值：0

最大值：9223372036854775807

malicious_file_num

Long

恶意文件数

最小值：0

最大值：9223372036854775807

host_num

Long

关联主机数

最小值：0

最大值：9223372036854775807

container_num

Long

关联容器数

最小值：0

最大值：9223372036854775807

component_num

Long

关联组件数

最小值：0

最大值：9223372036854775807

scan_failed_desc

String

扫描失败原因，包含如下10种。

  • "unknown_error":未知错误

  • "failed_to_match_agent":对应主机未开启容器版防护或agent离线

  • "create_container_failed":创建容器失败

  • "get_container_info_failed":获取容器信息失败

  • "docker_offline":docker引擎不在线

  • "get_docker_root_failed":获取容器根文件系统失败

  • "image_not_exist_or_docker_api_fault":镜像不存在或docker接口错误

  • "huge_image":超大镜像

  • "docker_root_in_nfs":容器根目录位于网络挂载

  • "response_timed_out":响应超时

最小长度：0

最大长度：64

请求示例

查询前10条本地镜像信息列表

GET https://{endpoint}/v5/{project_id}/image/local-repositories?offset=0&limit=10

响应示例

状态码： 200

successful response

{
  "data_list" : [ {
    "image_id" : "f757deea-781e-45ec-90ec-f199249890df",
    "image_name" : "webshell-ljx",
    "image_version" : "v1",
    "image_digest" : "sha256:ce0b5d91b072730d0bc9518f11efd07eb7fdb9f43251e11a96cab5b1918b7044",
    "local_image_type" : "swr_image",
    "scan_status" : "success",
    "image_size" : 215304488,
    "latest_update_time" : 1697509433000,
    "latest_scan_time" : 1709973506292,
    "host_num" : 0,
    "container_num" : 5,
    "component_num" : 146,
    "vul_num" : 77,
    "host_name" : "myhost",
    "host_id" : "9ad79426-992c-4be4-a2d1-dfd3a75b7c14",
    "agent_id" : "1c1d073c5fc403eb0d9c3088bc49da4e015586fd4864513a2fd81afedce282d4",
    "severity_level" : "High"
  } ],
  "total_num" : 1
}

状态码

状态码

描述

200

successful response

错误码

请参见错误码。

父主题： 容器镜像
分享：

    相关文档

    相关产品