镜像管理
镜像列表
- 接口说明：镜像列表
- 接口地址：a=list&c=image&m=admin
- 请求方式：GET
请求参数
| 参数名称 | 类型 | 描述 | 必填 | 示例值 |
|---|---|---|---|---|
| page | number | 页码 | 否 | 2 |
| s_name | string | 镜像名称 | 否 | urlos/php-fpm:7.4-nginx-ubuntu |
请求示例：
发起请求
curl -k "https://{你网站的ip或者域名}:9966/?a=list&c=image&m=admin&page={页码}&v=99999&globalApiNonceStr={随机字符串}&getJson=1&globalApiTimestamp={时间戳}&globalApiSign={签名字符串}"
返回结果
{
"columns": [], //表头数据
"pageInfo": {}, // 分页信息
"dataSource": [], //列表数据
"msg": {
"message": "", // 提交请求执行结果的信息
"msgType": "success", // 提交请求执行结果的状态，有success、error、info、warning、fail
"msgMark": null,
"msgCode": null,
"jumpUrl": null,
"waitTime": 2
},
"currentInfo": {},
"softwareInfo": {}
}
添加、修改镜像
- 接口说明：添加、修改镜像
- 添加镜像接口地址：a=add&c=image&m=admin
- 修改镜像接口地址：a=edit&c=image&m=admin
- 请求方式：POST
请求参数
| 参数名称 | 类型 | 描述 | 必填 | 示例值 |
|---|---|---|---|---|
| name | number | 镜像名称，不需要包含域名 | 是 | urlos/urlos:1.0.0 |
| url | string | 镜像地址，非官方开发者建议填写带域名的镜像地址， 否则有可能导致镜像下载失败 |
是 | hub.my-domain.com/username/nginx:1.0 |
| username | string | 如果镜像仓库需要登录才能下载，请输入登录镜像服务器的用户名 | 否 | username |
| password | string | 如果镜像仓库需要登录才能下载，请输入登录镜像服务器的密码， 留空则不需要保存到镜像服务器 |
否 | |
| developer | string | 开发者 | 否 | |
| developerWebsite | string | 开发者网址 | 否 | https://www.urlos.com |
| size | string | 镜像大小，单位为MB或者GB | 否 | 10MB |
| status | number | 状态：开启：1、关闭：0 | 是 | 1 |
| description | string | 不超过128个字符 | 否 |
序列化请求参数为键值对格式的字符串(注意：如果键值对的值是JSON格式数据，可能需要urlencode)：
"name={镜像名称}&url={镜像地址}&status={状态}&size={镜像大小}"
请求示例：
发起请求
curl -d "name={镜像名称}&url={镜像地址}&status={状态}&size={镜像大小}" "https://{你网站的ip或者域名}:9966/?a=add&c=image&m=admin&v=99999&globalApiNonceStr={随机字符串}&getJson=1&globalApiTimestamp={时间戳}&globalApiSign={签名字符串}"
返回结果
{
"msg": {
"message": "", // 提交请求执行结果的信息
"msgType": "success", // 提交请求执行结果的状态，有success、error、info、warning、fail
"msgMark": null,
"msgCode": null,
"jumpUrl": null,
"waitTime": 2
},
"currentInfo": {},
"softwareInfo": {}
}
删除镜像
- 接口说明：删除镜像
- 接口地址：a=delete&c=image&m=admin
- 请求方式：GET
请求参数
| 参数名称 | 类型 | 描述 | 必填 | 示例值 |
|---|---|---|---|---|
| id | number | 镜像ID | 是 | 20 |
请求示例：
发起请求
curl -k "https://{你网站的ip或者域名}:9966/?a=delete&c=image&m=admin&id={镜像ID}&v=99999&globalApiNonceStr={随机字符串}&getJson=1&globalApiTimestamp={时间戳}&globalApiSign={签名字符串}"
返回结果
{
"msg": {
"message": "", // 提交请求执行结果的信息
"msgType": "success", // 提交请求执行结果的状态，有success、error、info、warning、fail
"msgMark": null,
"msgCode": null,
"jumpUrl": null,
"waitTime": 2
},
"currentInfo": {},
"softwareInfo": {}
}