本地镜像列表查询 - ListImageLocal
功能介绍
本地镜像列表查询
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/image/local-repositories
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
主机所属的企业项目ID。 开通企业项目功能后才需要配置企业项目。 企业项目ID默认取值为“0”，表示默认企业项目。如果需要查询所有企业项目下的主机，请传参“all_granted_eps”。如果您只有某个企业项目的权限，则需要传递该企业项目ID，查询该企业项目下的主机，否则会因权限不足而报错。 |
|
image_name |
否 |
String |
镜像名称 |
|
image_version |
否 |
String |
镜像版本 |
|
offset |
否 |
Integer |
偏移量：指定返回记录的开始位置 |
|
limit |
否 |
Integer |
每页显示数量 |
|
scan_status |
否 |
String |
扫描状态，包含如下:
|
|
local_image_type |
否 |
String |
镜像类型，包含如下:
|
|
image_size |
否 |
Long |
镜像大小，单位字节 |
|
start_latest_update_time |
否 |
Long |
最近更新时间搜索开始日期，时间单位：毫秒（ms） |
|
end_latest_update_time |
否 |
Long |
最近更新时间搜索结束日期，时间单位：毫秒（ms） |
|
start_latest_scan_time |
否 |
Long |
最近一次扫描完成时间搜索开始日期，时间单位：毫秒（ms） |
|
end_latest_scan_time |
否 |
Long |
最近一次扫描完成时间搜索结束日期，时间单位：毫秒（ms） |
|
has_vul |
否 |
Boolean |
是否存在软件漏洞 |
|
host_name |
否 |
String |
本地镜像所关联服务器的名称 |
|
host_id |
否 |
String |
本地镜像所关联服务器的ID |
|
host_ip |
否 |
String |
本地镜像所关联服务器的IP（公网或私网） |
|
container_id |
否 |
String |
本地镜像所关联容器的ID |
|
container_name |
否 |
String |
本地镜像所关联容器的名称 |
|
pod_id |
否 |
String |
本地镜像所关联Pod的ID |
|
pod_name |
否 |
String |
本地镜像所关联Pod的名称 |
|
app_name |
否 |
String |
本地镜像所关联软件的名称 |
|
has_container |
否 |
Boolean |
参数解释: 是否存在容器 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
x-auth-token |
是 |
String |
用户Token。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_num |
Integer |
本地镜像总数 |
|
data_list |
Array of ImageLocalInfo objects |
本地镜像数据列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
image_name |
String |
镜像名称 |
|
image_id |
String |
镜像ID |
|
image_digest |
String |
镜像digest |
|
image_version |
String |
镜像版本 |
|
local_image_type |
String |
本地镜像类型 |
|
scan_status |
String |
扫描状态，包含如下：
|
|
image_size |
Long |
镜像大小，单位字节 |
|
latest_update_time |
Long |
镜像版本最后更新时间，时间单位毫秒（ms） |
|
latest_scan_time |
Long |
最近扫描时间，时间单位毫秒（ms） |
|
vul_num |
Long |
漏洞个数 |
|
unsafe_setting_num |
Long |
基线扫描未通过数 |
|
malicious_file_num |
Long |
恶意文件数 |
|
host_num |
Long |
关联主机数 |
|
container_num |
Long |
关联容器数 |
|
component_num |
Long |
关联组件数 |
|
scan_failed_desc |
String |
扫描失败原因，包含如下10种。
|
|
severity_level |
String |
镜像风险程度，在镜像扫描完成后展示，包含如下：
|
|
host_name |
String |
服务器名称 |
|
host_id |
String |
主机ID |
|
agent_id |
String |
Agent ID |
|
non_scan_reason |
String |
该镜像不支持扫描的原因；若该字段为空则表示镜像可以扫描 |
请求示例
查询前10条本地镜像信息列表
GET https://{endpoint}/v5/{project_id}/image/local-repositories?offset=0&limit=10
响应示例
状态码：200
请求已成功
{
"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 |
请求已成功 |
错误码
请参见错误码。
