镜像管理

镜像列表

  • 接口说明：镜像列表
  • 接口地址：a=list&c=image&m=admin
  • 请求方式：GET

请求参数

参数名称类型描述必填示例值
pagenumber页码否2
s_namestring镜像名称否urlos/php-fpm:7.4-nginx-ubuntu

请求示例：

发起请求
  1. curl -k "https://{你网站的ip或者域名}:9966/?a=list&c=image&m=admin&page={页码}&v=99999&globalApiNonceStr={随机字符串}&getJson=1&globalApiTimestamp={时间戳}&globalApiSign={签名字符串}"
返回结果
  1. {
  2.     "columns": [], //表头数据
  3.     "pageInfo": {}, // 分页信息
  4.     "dataSource": [], //列表数据
  5.     "msg": {
  6.         "message": "", // 提交请求执行结果的信息
  7.         "msgType": "success", // 提交请求执行结果的状态，有success、error、info、warning、fail
  8.         "msgMark": null,
  9.         "msgCode": null,
  10.         "jumpUrl": null,
  11.         "waitTime": 2
  12.     },
  13.     "currentInfo": {},
  14.     "softwareInfo": {}
  15. }

添加、修改镜像

  • 接口说明：添加、修改镜像
  • 添加镜像接口地址：a=add&c=image&m=admin
  • 修改镜像接口地址：a=edit&c=image&m=admin
  • 请求方式：POST

请求参数

参数名称类型描述必填示例值
namenumber镜像名称，不需要包含域名是urlos/urlos:1.0.0
urlstring镜像地址，非官方开发者建议填写带域名的镜像地址，
否则有可能导致镜像下载失败		是hub.my-domain.com/username/nginx:1.0
usernamestring如果镜像仓库需要登录才能下载，请输入登录镜像服务器的用户名否username
passwordstring如果镜像仓库需要登录才能下载，请输入登录镜像服务器的密码，
留空则不需要保存到镜像服务器		否
developerstring开发者否
developerWebsitestring开发者网址否https://www.urlos.com
sizestring镜像大小，单位为MB或者GB否10MB
statusnumber状态：开启：1、关闭：0是1
descriptionstring不超过128个字符否

序列化请求参数为键值对格式的字符串(注意：如果键值对的值是JSON格式数据，可能需要urlencode)：

  1. "name={镜像名称}&url={镜像地址}&status={状态}&size={镜像大小}"

请求示例：

发起请求
  1. curl -d "name={镜像名称}&url={镜像地址}&status={状态}&size={镜像大小}" "https://{你网站的ip或者域名}:9966/?a=add&c=image&m=admin&v=99999&globalApiNonceStr={随机字符串}&getJson=1&globalApiTimestamp={时间戳}&globalApiSign={签名字符串}"
返回结果
  1. {
  2.     "msg": {
  3.         "message": "", // 提交请求执行结果的信息
  4.         "msgType": "success", // 提交请求执行结果的状态，有success、error、info、warning、fail
  5.         "msgMark": null,
  6.         "msgCode": null,
  7.         "jumpUrl": null,
  8.         "waitTime": 2
  9.     },
  10.     "currentInfo": {},
  11.     "softwareInfo": {}
  12. }

删除镜像

  • 接口说明：删除镜像
  • 接口地址：a=delete&c=image&m=admin
  • 请求方式：GET

请求参数

参数名称类型描述必填示例值
idnumber镜像ID是20

请求示例：

发起请求
  1. curl -k "https://{你网站的ip或者域名}:9966/?a=delete&c=image&m=admin&id={镜像ID}&v=99999&globalApiNonceStr={随机字符串}&getJson=1&globalApiTimestamp={时间戳}&globalApiSign={签名字符串}"
返回结果
  1. {
  2.     "msg": {
  3.         "message": "", // 提交请求执行结果的信息
  4.         "msgType": "success", // 提交请求执行结果的状态，有success、error、info、warning、fail
  5.         "msgMark": null,
  6.         "msgCode": null,
  7.         "jumpUrl": null,
  8.         "waitTime": 2
  9.     },
  10.     "currentInfo": {},
  11.     "softwareInfo": {}
  12. }