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

查询本地镜像的容器信息 - ListLocalImageContainers

功能介绍

查询本地镜像的容器信息

授权信息

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

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

URI

GET /v5/{project_id}/image/local/containers

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

主机所属的企业项目ID。

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

企业项目ID默认取值为“0”,表示默认企业项目。如果需要查询所有企业项目下的主机,请传参“all_granted_eps”。如果您只有某个企业项目的权限,则需要传递该企业项目ID,查询该企业项目下的主机,否则会因权限不足而报错。

image_digest

String

镜像digest

image_name

String

镜像名称

image_version

String

镜像版本

container_id

String

容器id

offset

Integer

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

limit

Integer

每页显示个数

agent_id

String

Agent Id

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)

region

String

Region ID

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total_num

Integer

总数

data_list

Array of LocalImageContainerInfo objects

查询本地镜像的容器列表

表5 LocalImageContainerInfo

参数

参数类型

描述

agent_id

String

Agent id

container_name

String

容器名称

container_id

String

容器ID

host_id

String

服务器ID

host_name

String

服务器名称

pod_id

String

pod id

pod_name

String

pod名称

private_ip

String

私有IP地址

public_ip

String

弹性公网IP地址

entry_point

String

启动命令

请求示例

响应示例

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档