用于向 ECS 或者 Swarm 集群部署应用。

功能

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

POST /pop/v5/changeorder/co_deploy HTTPS|HTTP

请求参数

名称 类型 是否必选 示例值 描述
AppId String 3616cdca-********************

应用 ID (查询 ListApplication 接口获取)

DeployType String url

部署类型只能填:“url” 或 “image”,其中只有docker应用支持镜像(image)部署

GroupId String all

部署分组 ID(根据 ListDeployGroup 接口获取),全部分组填 “all”

PackageVersion String 1.0

发布版本要求同一个应用唯一性最长64个字符,建议使用时间戳。

Desc String “”

部署描述

WarUrl String “”

deployType 为 url 时必填,WAR 包上传存储地址,建议使用 OSS

ImageUrl String “”

镜像地址,选择 image 类型时必填

Batch Integer 1

默认1批,最大5批

BatchWaitTime Integer 5

等待时间。默认 0,不等待;最大 5 分钟。

AppEnv String “”

部署环境变量,格式必须符合

{"name":"x","value":"y"},{"name":"x2","value":"y2"}

key 固定为 name 和 value。

BuildPackId Long 1382974398

如果在创建应用时没有指定运行环境,且没有部署,

原生 Dubbo 或者 Spring Cloud 应用在第一次部署时可以不填。

非原生 Dubbo 或者 Spring Cloud 应在第一次部署时需要指定这个字段。(根据获取容器版本列表接口 ListBuildPack 查询获取或者参见 “容器版本” 表格中的 “构建包序号” 列获取)。

ComponentIds String 5

如果在创建应用时没有指定运行环境,且没有部署,

原生 Dubbo 或者 Spring Cloud 应用在第一次通过 WAR 包部署时,需要通过这个字段指定部署所依赖的 Apache Tomcat 组件的版本。(根据获取组件列表接口 ListComponents 接口查询)。

非原生 Dubbo 或者 Spring Cloud 应用在第一次通过 WAR 包部署时,可以不填。

ReleaseType Long 1

分批方式。

0为自动。

1为批次间需要手动确认。可在管控台手动“继续下一批”,也可通过调用 ContinuePipeline 继续下一批。

返回数据

名称 类型 示例值 描述
Code Integer 200

code 码

Message String success

信息

ChangeOrderId String d6834ee9-5045-*************

调用 GetChangeOrderInfo 接口获取这次部署具体执行进展

RequestId String F8DFGEDK98***************

示例

请求示例

POST /pop/v5/changeorder/co_deploy HTTP/1.1
公共请求头
{
  "AppId": ""
  "DeployType": ""
  "GroupId": ""
  "PackageVersion": ""
}

正常返回示例

JSON 格式

{
	"Message": "success",
	"ChangeOrderId": "d6834ee9-5045-*************",
	"Code": 200
}

XML 格式

<Message>success</Message>
<ChangeOrderId>d6834ee9-5045-*************</ChangeOrderId>
<Code>200</Code>

错误码

访问错误中心查看更多错误码。