拉取镜像

更新时间:
2025-01-14

拉取镜像

此接口用于将远程仓库的镜像拉取至本地仓库。

接口描述

通信协议:HTTP

URL:POST /api/v1/image/sync

传参方式:body

请求参数

字段名 类型 是否必填 说明
registryIdstring远程仓库 ID
imageNamestring镜像名称
imageSizeint镜像大小,单位为 MB
tagstring镜像版本
idstring镜像 ID
osstring镜像系统,如 Linux、SylixOS
archstring镜像架构,如 arm64,amd64

响应参数

字段名 类型 说明
syncIdstring拉取任务 ID

请求示例

curl --location --request POST 'http://localhost:3001/api/v1/image/sync' \
--header 'Referer: https://192.168.128.1/' \
--header 'Content-Type: application/json' \
--data-raw '{
  "id": "1",
  "imageName": "registry-ui",
  "tag": "65.7",
  "registryId": "5df6d066-192d-49e5-8ceb-5cfcf5a2c8fa",
  "imageSize": 100,
  "os": "linux",
  "arch": "x86-64"
}'

响应示例

{
  "status": 200,
  "message": "success",
  "fieldErrors": null,
  "data": {
    "syncId": "f6c287a5-d9cc-4877-8e50-53455b98213d"
  }
}

错误码

具体请参见 错误码说明

文档内容是否对您有所帮助?
有帮助
没帮助