更新时间:2024-04-18 GMT+08:00
分享

API概览

通过使用容器镜像服务提供的接口,您可以实现对组织、镜像仓库、镜像信息的查询,也可以实现对组织、镜像仓库、镜像的管理操作。

组织管理

API

说明

创建组织

创建组织。

删除组织

删除组织。

查询组织列表

查询组织列表。

获取组织详情

查询某个组织的详细信息,包括组织ID、组织名称、创建者和用户权限。

镜像仓库管理

API

说明

在组织下创建镜像仓库

在组织下创建镜像仓库。

删除组织下的镜像仓库

删除组织下的镜像仓库。

更新镜像仓库的概要信息

更新组织下的镜像仓库概要信息,包括镜像类型、是否公有、描述信息。

查询镜像仓库概要信息

查询组织下镜像仓库的概要信息,包括仓库ID、组织ID、仓库名称、仓库描述信息、仓库创建者、仓库大小、镜像pull路径等。

查询镜像仓库列表

查询镜像仓库列表。

查询共享镜像列表

查看共享镜像列表。

镜像版本管理

API

说明

查询镜像tag列表

查询某一个镜像仓库的所有镜像版本。

删除指定tag的镜像

删除镜像仓库中指定tag的镜像。

共享账号管理

API

说明

创建共享账号

创建共享账号。镜像上传后,您可以共享私有镜像给其他账号,并授予下载该镜像的权限。

删除共享账号

删除共享账号。

更新共享账号

更新共享账号。

判断共享账号是否存在

判断共享账号是否存在。

获取共享账号列表

获取共享账号列表。

API版本信息

API

说明

查询所有API版本信息

查询容器镜像服务所有可用的API版本信息列表。

查询指定API版本信息

查询容器镜像服务指定API版本信息列表。

组织权限管理

API

说明

创建组织权限

为组织添加授权,使某些用户可以管理/编辑/读取该组织下的镜像。

删除组织权限

删除某些用户对组织的操作权限。

更新组织权限

更新某些用户对组织的操作权限类型。

查询组织权限

查询组织权限。

镜像权限管理

API

说明

创建镜像权限

为镜像授权,使某些用户可以管理/编辑/读取该镜像。

删除镜像权限

删除某些用户对镜像的操作权限。

更新镜像权限

更新某些用户对镜像的操作权限类型。

查询镜像权限

查询镜像的权限。

镜像自动同步管理

API

说明

获取镜像自动同步任务信息

创建镜像自动同步任务后,可以通过此接口查询该任务的状态,以判断是否同步成功。

获取镜像自动同步任务列表

获取为当前镜像仓库所创建的所有自动同步任务。

创建镜像自动同步任务

创建镜像自动同步任务,帮助您把最新推送的镜像自动同步到其他区域镜像仓库内。 镜像自动同步帮助您把最新推送的镜像自动同步到其他区域镜像仓库内,后期镜像有更新时,目标仓库的镜像也会自动更新,但已有的镜像不会自动同步。已有镜像的同步需要手动操作,详情请参见手动同步镜像

删除镜像自动同步任务

根据目标区域、目标组织删除指定的镜像自动同步任务。

手动同步镜像

对于镜像仓库已有的镜像,如果想在其他区域使用,需要手动触发镜像同步。判断是否同步成功的方法如下:

  • 响应状态码为200,无报错信息,表示同步成功。
  • 通过SWR管理控制台或调用查询镜像仓库概要信息接口,在目标区域的目标组织下,若存在所同步的镜像版本表示同步成功。

触发器管理

API

说明

创建触发器

创建触发器。

获取镜像仓库下的触发器列表

获取镜像仓库下的触发器列表。

删除触发器

删除触发器。

获取触发器详情

获取触发器详情。

更新触发器配置

更新触发器的状态。

镜像老化规则管理

API

说明

创建镜像老化规则

创建镜像老化规则。

获取镜像老化规则列表

获取镜像老化规则列表。

删除镜像老化规则

删除镜像老化规则。

获取镜像老化规则记录

获取镜像老化规则记录。

修改镜像老化规则

修改镜像老化规则。

获取镜像老化记录

获取镜像老化记录。

临时登录指令

API

说明

生成临时登录指令

通过获取响应消息头的X-Swr-Dockerlogin的值及响应消息体的host值,可生成临时登录指令。

配额管理

API

说明

获取配额信息

获取配额信息。

相关文档