开发者社区 问答 正文

Swarm API参考  应用API列表  创建应用实例

[font=PingFangSC, "]创建一个新的应用实例。

请求信息


请求行 RequestLinePOST /projects/ HTTP/1.1
请求行参数 URI Param

特有请求头 RequestHeadContent-Type: application/json
请求体 RequestBody
JSON object
{
    "name": "string",
    "description": "string",
    "template": "string",
    "version": "string",
    "environment": {
       "key": "value",
       ...
    }
}

请求体解释 environment

[tr=rgb(51, 205, 229)][td]名称 类型必须描述namestring是应用名称。名称为 1~64 个字符,可包含数字,英文字符和连字符(-),且不能以连字符(-)开头。descriptionstring否应用描述。templatestring是字符串格式的应用的 Compose yaml 模板,注意需要按照 JSON 格式进行转义。versionstring否应用版本,缺省值为 1.0。[tr=rgb(239, 251, 255)][td] map否key/value 用于替换 Compose 模板的变量参数。 latest_imagebool否创建应用前,是否需要更新镜像。

返回信息



返回行 ResponseLineHT TP/1.1 201 Created
特有返回头 ResponseHeadLocation /projects/<name>

示例


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

返回示例HTTP/ 1.1 201 CreatedLocation /projects/test
https://help.aliyun.com/document_detail/26066.html

展开
收起
青蛙跳 2018-08-31 23:34:06 1468 分享 版权
阿里云 AI 助理回答

根据您的需求,创建一个新的应用实例可以通过发送一个HTTP POST请求来实现。以下是操作步骤和相关参数的详细说明:

请求信息

  1. 请求方法与路径

    • 使用POST方法向/projects/路径发起请求。
  2. Content-Type

    • 设置请求头Content-Typeapplication/json,表明请求体内容格式为JSON。
  3. 请求体内容

    • name(必填): 应用名称,长度限制在1~64个字符,可包含数字、英文字符和连字符(-),但不能以连字符开头。例如:"test-app"。
    • description(可选): 应用描述,如:"这是一个测试应用"。
    • template(必填): 字符串格式的应用Compose YAML模板,需符合JSON格式转义规则。例如:"web:\n image: nginx"
    • version(可选): 应用版本,默认值为"1.0"。
    • environment(可选): 用于替换Compose模板变量参数的键值对映射。例如:{"USER": "abc", "PWD": "password"}

示例请求

POST /projects HTTP/1.1
Content-Type: application/json

{
    "name": "test-app",
    "description": "这是一个示例应用",
    "template": "web:\n  image: nginx",
    "version": "1.0",
    "environment": {
        "ENV_VAR1": "value1",
        "ENV_VAR2": "value2"
    }
}

返回信息

  • 成功响应的状态码为201 Created,表示新应用实例已成功创建。
  • Location头部会返回新创建应用的资源定位,例如:/projects/test-app

返回示例

HTTP/1.1 201 Created
Location: /projects/test-app

此过程将根据提供的JSON数据创建一个新的应用实例,并且如果操作成功,服务器将以状态码201 Created响应,并通过Location头部告知新创建资源的位置。请确保您有权限执行此操作,并且遵循服务提供商的具体要求和限制。

有帮助
无帮助
AI 助理回答生成答案可能存在不准确,仅供参考
0 条回答
写回答
取消 提交回答