镜像

镜像存储空间信息

功能介绍

查询镜像存储空间的总量和剩余空间

URI

示例：product_type_list=[image]

GET /api/ecns/${product type}/images/systeminfo/volumes

响应消息

参数	参数类型	描述
	dict

响应示例

{
        "storage": {
        "free": 4864376832,
        "total": 5150212096

    }
}

镜像存储空间垃圾收集（Garbage Collection，GC）

功能介绍

回收镜像存储空间垃圾

URI

示例：product_type_list=[image]

POST /api/ecns/${product type}/images/system/gc/schedule

请求消息

参数	参数类型	是否必选	描述
type	str	是	“Manual”开始GC，”None”停止GC

查看GC状态

功能介绍

查看垃圾回收的过程是否完成

URI

示例：product_type_list=[image]

GET /api/ecns/${product type}/images/system/gc/schedule

响应消息

参数	参数类型	描述
job_status	str	“finished” gc过程完成，“pending” gc过程进行中

列举镜像

功能介绍

根据权限枚举镜像

接口约束

当public为true时，列举共有镜像

当public为false时，列举私有镜像

当且仅当为管理员帐号时可无public这个参数，会列举出所有镜像

URI

示例:product_type_list=[image]

GET /api/ecns/${product type}/images/repositories/?page=5&page_size=20&public=true

参数	参数类型	是否必选	描述
public	str	否

响应消息

参数	参数类型	描述
images	list(image_base)

image_base Type 定义：

参数	参数类型	描述
name	str
harbor_project_name	str	UE中对应“工作空间”名称
creation_time	str
tags_count	int	版本数目
domain_project_info	domain_project_info	部门、项目信息
id	str	兼容前端作为唯一标识符使用
description	str	镜像详情中展示，UE支持Markdown，列表中用此字段来获取“编辑”时的内容
public	str	镜像访问级别，”True”表示公有镜像；“False”表示私有镜像

domain_project_info Type定义：

参数	参数类型	描述
domain_name	str	“部门”名称
openstack_project_name	str	“项目”名称

列举镜像版本

URI

示例:product_type_list=[image]

GET /api/ecns/${product type}/images/repositories/<harbor_project_name>/<image_name>/tags/

响应消息

参数	参数类型	描述
tags	list(tag_info)

tag_info Type 定义：

参数	参数类型	描述
tag_name	str
creation_time	str
size	int	单位为B
docker_version	str
pull_command	str	下载命令

镜像详情

功能介绍

查询镜像占用空间和下载次数

URI

示例：product_type_list=[image]

GET /api/ecns/${product type}/images/repositories/<harbor_project_name>/<image_name>

响应消息

image_info Type定义：

参数	参数类型	描述
image_base	image_base
size	int	占用空间
pull_count	int	下载次数

页面上传镜像

URI

示例：product_type_list=[image]

POST /api/ecns/${product type}/images/upload_image/

请求信息

参数	参数类型	是否必选	描述
image	file	是	上传文件
harbor_project_name	str	是	工作空间名称
image_name	str	否	镜像名称
tag_name	str	否	tag名称

Push镜像

前提条件

私有仓库push前需要登录，需要username/password登录

URI

示例：product_type_list=[image]

GET /api/ecns/${product type}/images/loginfo/

响应消息

参数	参数类型	描述
username	str	登录用户名
password	str	登录秘密
harbor_domain	str	镜像仓库的访问域名
public_vip	str	平台访问的地址，从ems命名空间下的configs类型的 clusterconfig cr获得

编辑镜像

URI

示例：product_type_list=[image]

PUT /api/ecns/${product type}/images/repositories/<harbor_project_name>/<image_name>

请求消息

参数	参数类型	是否必选	描述
description	str	是	镜像描述

镜像删除

示例：product_type_list=[image]

DELETE /api/ecns/${product type}/images/repositories/

请求消息

参数	参数类型	是否必选	描述
images	list(dict)	是	镜像名称列表

dict格式：

参数	参数类型	描述
harbor_project_name	str	“工作空间”名称
image_name	str	镜像名称

镜像版本删除

URI

示例：product_type_list=[image]

DELETE /api/ecns/${product type}/images/repositories/<harbor_project_name>/<image_name>/tags/

请求消息

参数	参数类型	是否必选	描述
tags	list(str)	是	版本名称列表