更新一个应用实例的配置信息。

请求信息

请求行 RequestLine

POST /projects/{name}/update HTTP/1.1

请求行参数 URI Param

名称 类型 是否必须 描述
name string 应用实例名称

特有请求头 RequestHead

Content-Type: application/json

请求体 RequestBody

JSON object

{
    "description": "string",
    "template": "string",
    "version": "string",
    "latest_image": true,
    "environment": {
       "key": "value",
       ...
    }
}

请求体解析

名称 类型 必须 描述
description string 更新的应用描述。
template string 更新的 Compose yaml 模板,注意需要按照 JSON 格式进行转义。
version string 更新的应用版本,更新的版本应和原有版本不同,否则会返回 HTTP code 409。
latest_image bool 是否拉取最新镜像
environment map 环境变量 key/value 用于替换 Compose 模板的环境变量

返回信息

返回行 ResponseLine

HTTP/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