查询部署记录详情

更新时间:
2025-01-14

查询部署记录详情

此接口用于查询服务下某个部署记录的详细信息。

接口描述

通信协议:HTTP

URL: GET /api/v1/service/record/:id

传参方式:path

请求参数

字段名类型是否必填说明
idstring部署记录 ID

响应参数

字段名类型说明
actionstring部署类型
cmdstring容器启动命令
configDockerImageConfig | EcsImageConifg镜像配置信息,其中 DockerImageConfig 为 Linux 系统镜像配置信息,EcsImageConifg 为 SylixOS 系统镜像配置信息
namestring服务名称
vsoaImageVsoaVSOA 配置
nodeNode服务部署的节点信息
imageImageInfo服务部署的镜像信息
createdTimestring服务部署时间
policystring服务部署策略。static 表示静态部署;dynamic 表示动态部署
factornumber动态部署时的容器实例个数

ImageInfo

字段名类型说明
refstring镜像引用,形式 name@tag#os
pathstring镜像的位置
pullPolicyenum镜像拉取策略,各策略说明如下:
  • IfNotPresent: 如果待部署节点本地有对应镜像,则使用本地镜像;如果待部署节点本地没有对应镜像,则从 ECSM 镜像仓库拉取
  • Always: 总是从 ECSM 仓库查询镜像摘要,如果本地存在与其相同的镜像则使用本地的,否则会拉取最新的镜像
  • Never: 从不向 ECSM 仓库拉取镜像,只使用待部署节点的本地镜像,如果没有则报错
当镜像的 tag 为 latest 时默认拉取策略为 Always, 当镜像的 tag 为具体版本号时默认拉取策略为 IfNotPresent
autoUpgradeenum服务自动更新策略,各策略说明如下:
  • Never:从不自动更新
  • Larger:当与对应镜像名称相同的新镜像被上传或 Push 到 ECSM 镜像仓库时,ECSM 将根据 Semantic Versioningopen in new window 语义化版本规范对比两个镜像的版本大小,如果新镜像的版本较大,则自动更新服务,并将服务镜像替换为高版本的镜像。tag 为 latest 的镜像总是被当做较大版本的镜像
  • Always:当与对应镜像名称相同的新镜像被上传或 Push 到 ECSM 镜像仓库时,将自动使用新镜像更新服务
默认策略为 Never,从不自动更新

请求示例

curl --location --request GET 'http://192.168.XX.XX/api/v1/service/record/b737625f-6f7d-45f7-b8d9-ee2d3047559b'

响应示例

{
    "status": 200,
    "message": "success",
    "fieldErrors": null,
    "data": {
        "action": "run",
        "cmd": [
            "/hello"
        ],
        "config": {
            "hostname": "foo",
            "env": [
                "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
            ],
            "cmd": [
                "/hello"
            ],
            "name": "foo",
            "restart": "no",
            "network": "bridge",
            "memory": 0,
            "healthCmd": []
        },
        "name": "foo",
        "nodeList": [
            {
                "nodeId": "39854d09-f89b-46b8-8398-081787930964",
                "nodeName": "192.168.XX.XX",
                "address": "192.168.XX.XX:1112"
            },
            {
                "nodeId": "ea9ca0d4-13ad-42f9-b400-329626d8159a",
                "nodeName": "192.168.XX.XX",
                "address": "192.168.XX.XX:1112"
            }
        ],
        "image": {
            "id": "0d1fd57d-5b61-4aba-a97f-3d3654618c4b",
            "path": "local/hello-world@v2",
        },
        "createdTime": "2023-02-14 18:47:12",
        "policy": "static",
        "factor": 2
    }
}

错误码

具体请参见 错误码说明

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