新增发布单
更新时间 2025-12-03 10:22:16
最近更新时间: 2025-12-03 10:22:16
接口功能介绍
调用addPlan接口新增发布单
接口约束
无
URI
POST /v2/plan/addPlan
路径参数 无
Query参数 无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池ID，请参考调用前必知-概述 | bb9fdb42056f11eda1610242ac110002 |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| name | 是 | String | 发布单名称 | ||
| clusterType | 是 | String | 集群类型，只能为ECS或KUBERNETES | ||
| envUuid | 是 | String | 环境uuid | ||
| deployStrategy | 是 | Object | 部署策略 | deployStrategy | |
| deployUnitList | 是 | Array of Strings | 部署单元列表 | ||
| list | 是 | Array of Objects | 应用实例列表 | list | |
| 表 list |
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| appDeployUuid | 是 | String | 应用实例uuid | ||
| appDeployInstVersionUuid | 是 | String | 应用实例版本uuid | ||
| appDeployInstEcsGroupUuid | 否 | String | ECS应用实例分组uuid | ||
| 表 deployStrategy |
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| grayUpdate | 是 | Boolean | 是否灰度部署 | ||
| batchNum | 是 | Integer | 每组批次 | ||
| firstBatchNum | 否 | Integer | 首批数量 | ||
| betweenBatchProcessingMode | 是 | String | 批次间处理方式，仅支持自动AUTO和手动MANUAL | ||
| batchWaitTime | 否 | Integer | 间隔时间，单位分钟，betweenBatchProcessingMode=AUTO时必填 | ||
| groupId | 否 | String | 泳道组id，适用于按泳道灰度发布 | ||
| grayRule | 否 | Object | 灰度规则 | grayRule | |
| 表 grayRule |
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| grayType | 否 | String | 灰度类型，值可为PERCENT和SWIMMING | ||
| percent | 否 | Array of Objects | 流量灰度，数据类型为列表 | [{ | |
| "tag": "demoData", | |||||
| "rate": 50 | |||||
| }] | percent | ||||
| swimming | 否 | Object | 泳道灰度 | { | |
| "tag": "demoData", | |||||
| "id": 1, | |||||
| "uuid": "demoData", | |||||
| "name": "demoData", | |||||
| "groupId": 1, | |||||
| "groupName": "demoData", | |||||
| "swimmingId": 1, | |||||
| "swimmingName": "demoData", | |||||
| "appId": "demoData", | |||||
| "appName": "demoData" | |||||
| } | swimming | ||||
| 表 swimming |
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| tag | 否 | String | 标签名 | ||
| id | 否 | Long | 泳道策略ID | ||
| uuid | 否 | String | 泳道策略uuid | ||
| name | 否 | String | 泳道策略名称 | ||
| groupId | 否 | Long | 泳道组ID | ||
| groupName | 否 | String | 泳道组名称 | ||
| swimmingId | 否 | Long | 泳道ID | ||
| swimmingName | 否 | String | 泳道名称 | ||
| rule | 否 | Object | 泳道规则 | rule | |
| appId | 否 | String | 全链路流量appId | ||
| appName | 否 | String | 应用名称 | ||
| 表 rule |
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| path | 否 | String | 请求路径 | ||
| condition | 否 | String | 条件 | ||
| conditionItems | 否 | Array of Objects | 条件列表 | conditionItems | |
| 表 conditionItems |
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| type | 否 | String | 类型 | ||
| param | 否 | String | 参数 | ||
| cond | 否 | String | 条件 | ||
| value | 否 | String | 值 | ||
| operator | 否 | String | 操作 | ||
| 表 percent |
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| tag | 否 | String | 标签 | ||
| rate | 否 | Integer | 流量比例 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 响应编码 2000 success | ||
| message | String | 消息内容 | ||
| returnObj | Object | 返回数据 | returnObj | |
| error | String | 调用错误时返回的错误编码 | ||
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| planUuid | String | 发布单uuid |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"name": "666",
"clusterType": "ECS",
"deployUnitList": [
"3515bedc48f94d5b8443e8cc74af21e9",
"609788d274844936a11843f166cb29f8",
"2485fd08605b44d08291d07dae52ffca",
"e4252e5175304beea36e7839a5b835c2"
],
"deployStrategy": {
"grayUpdate": false,
"batchNum": 1,
"betweenBatchProcessingMode": "MANUAL",
"firstBatchNum": 1
},
"envUuid": "e5fd85fc7f014d938e972a5413072e2e",
"list": [
[
{
"appDeployUuid": "4daa0cfbf1de4c90bee65c16cdbdc16c",
"appDeployInstVersionUuid": "b11023b9b8444850933d6c3f9717d472"
}
]
]
}
响应示例
{
"statusCode": 2000,
"message": "成功",
"returnObj": {
"planUuid": "cfe8c62e3a1a4b80bb7eb841254bd05c"
}
}
状态码
请参考 状态码
错误码
请参考 错误码
