Swarm API参考  应用API列表  更新应用配置

[font=PingFangSC, "]更新一个应用实例的配置信息。

请求信息


请求行 RequestLinePOST /projects/{name}/update HTTP/1.1
请求行参数 URI Param

[tr=rgb(51, 205, 229)][td]名称 类型是否必须描述namestring是应用实例名称
特有请求头 RequestHeadContent-Type: application/json
请求体 RequestBody
JSON object
{
    "description": "string",
    "template": "string",
    "version": "string",
    "latest_image": true,
    "environment": {
       "key": "value",
       ...
    }
}

请求体解析 [tr=rgb(51, 205, 229)][td]名称 类型必须描述descriptionstring否更新的应用描述。templatestring是更新的 Compose yaml 模板，注意需要按照 JSON 格式进行转义。versionstring否更新的应用版本，更新的版本应和原有版本不同，否则会返回 HTTP code 409。latest_imagebool否是否拉取最新镜像environmentmap环境变量key/value 用于替换 Compose 模板的环境变量

返回信息


返回行 ResponseLineH TTP/1.1 202 Accepted
特有返回头 ResponseHead
无
返回体 ResponseBody
无

示例


请求示例
POST /projects/test/update HTTP/1.1
Content-Type: application/json
{
  "description": "This is a test application",
  "template": "web:\r\n  image: nginx",
  "version": "2.0",
  "latest_image": true,
  "environment": {
    "USER": "abc",
    "PWD": "newpwd"
  }
}

返回示例
HTTP/1.1 202 Accepted