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

查询镜像的基础镜像信息 - ListImageBasicImage

功能介绍

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

授权信息

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

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

URI

GET /v5/{project_id}/image/{image_id}/basic-image

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

image_id

String

镜像id

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

主机所属的企业项目ID。

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

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

limit

Integer

每页显示个数

offset

Integer

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

image_type

String

镜像类型,包含如下:

  • private_image : 私有镜像仓库

  • shared_image : 共享镜像仓库

  • instance_image : 企业镜像

  • cicd : cicd镜像

  • harbor :Harbor仓库镜像

namespace

String

组织名称

image_name

String

镜像名称

image_version

String

镜像版本名称

os_name

String

os名称

请求参数

表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 ImageBasicImageInfo objects

镜像的基础镜像信息

表5 ImageBasicImageInfo

参数

参数类型

描述

os_name

String

基础镜像的系统名称

os_version

String

基础镜像的系统版本

layer_digest

String

基础镜像的层digest

请求示例

  • 查询私有镜像的基础镜像信息

    GET https://{endpoint}/v5/{project_id}/image/{image_id}/basic-image?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/basic-image?offset=0&limit=200&image_type=cicd&enterprise_project_id=all_granted_eps

响应示例

状态码:200

请求已成功

{
  "total_num" : 1,
  "data_list" : [ {
    "os_name" : "Debian",
    "os_version" : "9",
    "layer_digest" : "sha256:27833a3ba0a545deda33bb01eaf95a14d05d43bf30bce9267d92d17f069fe897"
  } ]
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档