查询镜像列表
此接口用于按条件查询镜像列表。
接口描述
通信协议：HTTP
URL：GET /api/v1/image
传参方式：query
请求参数
| 字段名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| registryId | string | 是 | 要查询的仓库主键，本地仓库为 local |
| pageNum | number | 是 | 当前页码数 |
| pageSize | number | 是 | 每页的镜像数量 |
| name | string | 否 | 镜像名称 |
| os | string | 否 | 镜像系统，如 Linux、SylixOS |
| author | string | 否 | 镜像开发者 |
响应参数
| 字段名 | 类型 | 说明 |
|---|---|---|
| total | number | 镜像总数 |
| pageNum | number | 当前页码数 |
| pageSize | number | 每页的镜像数量 |
| list | List[ ] | 具体的镜像数据 |
| status | boolean | 镜像仓库是否有效。true 表示有效镜像仓库； false 表示无效镜像仓库 |
List
| 字段名 | 类型 | 说明 |
|---|---|---|
| id | string | 镜像主键 |
| name | string | 镜像名称 |
| os | string | 镜像系统，如 Linux、SylixOS |
| createdTime | string | 镜像创建时间 |
| tag | string | 标签 |
| size | number | 镜像大小，单位为 MB。小数点后保留两位，如果镜像小于 0.01 MB， 则返回 0.01 MB |
| author | string | 镜像开发者 |
| arch | string | 镜像架构，如 amd64，x86 等 |
| pulled | boolean | 如果查询的是远端镜像，则此字段表示该镜像在本地仓库是否存在 |
请求示例
curl --location --request GET 'http://localhost:3001/api/v1/image?registryId=local&pageNum=1&pageSize=10'
响应示例
{
"status": 200,
"message": "success",
"fieldErrors": null,
"data": {
"total": 2,
"list": [
{
"id": "673a9cad-d1f7-4547-b4ba-9538ae95149e",
"name": "vsoa-auto-port",
"os": "linux",
"tag": "latest",
"size": 339.8,
"author": null,
"arch": "x86-64",
"createdTime": "2022-11-17T08:09:48.505920489Z",
"description": "",
"ociVersion": "v1",
"pulled": true
},
{
"id": "bc33e9cc-68c7-4139-b319-cd60b01aea2c",
"name": "hello-world",
"os": "linux",
"tag": "latest",
"size": 0.01,
"author": null,
"arch": "x86-64",
"createdTime": "2019-01-01T01:29:27.650294696Z",
"description": "",
"ociVersion": "v1",
"pulled": true
}
],
"pageNum": 1,
"pageSize": 10
}
}
错误码
具体请参见 错误码说明。
京公网安备11010802043204号