新增批量发布单
更新时间 2025-12-03 10:22:21
最近更新时间: 2025-12-03 10:22:21
接口功能介绍
调用addPlanBatch接口新增批量发布单
接口约束
无
URI
POST /v2/plan/addPlanBatch
路径参数 无
Query参数 无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池ID，请参考调用前必知-概述 | bb9fdb42056f11eda1610242ac110002 |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| name | 是 | String | 发布单名称 | ||
| clusterType | 是 | String | 集群类型，只能为ECS或KUBERNETES | ||
| appList | 是 | Array of Strings | 所属应用，填写应用uuid | ||
| envList | 是 | Array of Objects | 所属环境列表 | envList | |
| deployStrategy | 是 | Object | 部署策略 | deployStrategy | |
| batchDeployStrategy | 否 | Object | 环境部署策略 | batchDeployStrategy | |
| taskList | 是 | Array of Objects | 批量发布单任务列表 | taskList | |
| 表 taskList |
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| envUuid | 是 | String | 环境uuid | ||
| list | 是 | Array of Objects | 批量发布单实例列表 | list | |
| 表 list |
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| appDeployUuid | 是 | String | 应用实例uuid | ||
| appDeployInstVersionUuid | 是 | String | 应用实例版本uuid | ||
| appDeployInstEcsGroupUuid | 否 | String | ECCS应用实例分组uuid | ||
| 表 batchDeployStrategy |
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| betweenBatchProcessingMode | 是 | String | 批次间处理方式仅支持自动AUTO和手动MANUAL | ||
| batchWaitTime | 否 | Integer | 批次间隔时间，批次间处理方式为AUTO时必填 | ||
| 表 deployStrategy |
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| grayUpdate | 是 | Boolean | 是否灰度部署，只能填写false，批量发布单不支持灰度发布 | ||
| batchNum | 是 | Integer | 每组批次，最小为1 | ||
| betweenBatchProcessingMode | 是 | String | 批次间处理方式，仅支持自动AUTO和手动MANUAL | ||
| batchWaitTime | 否 | Integer | 批次间隔时间，单位为分钟，批次间处理方式为AUTO时必填 | ||
| 表 envList |
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| envUuid | 是 | String | 环境uuid | ||
| deployUnitList | 是 | Array of Strings | 部署单元uuid列表 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 响应编码 2000 success | ||
| message | String | 消息内容 | ||
| returnObj | Object | 返回数据 | returnObj | |
| error | String | 调用错误时返回的错误编码 | ||
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| planBatchUuid | String | 批量发布单uuid |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"name": "test",
"clusterType": "KUBERNETES",
"appList": [
"250b70747d27442ea0149e2b603937c2",
"5c07fcac370c4dbcae8b7fb5192dc81a"
],
"envList": [
{
"envUuid": "d5ae1a51ba374957bfcedc6ff5fd386d",
"deployUnitList": [
"ade272694caf46c5aac1054b38f9e6e9",
"047321bcd24347b19e74b83f8c32d942",
"c5d5885aebbb4182a0d952f99216950d"
]
}
],
"deployStrategy": {
"grayUpdate": false,
"batchNum": 1,
"betweenBatchProcessingMode": "AUTO",
"batchWaitTime": 1,
"firstBatchNum": 1
},
"taskList": [
[
{
"envUuid": "d5ae1a51ba374957bfcedc6ff5fd386d",
"list": [
[
{
"appDeployUuid": "ccc32e71b5ea4d7d9061c6e502f8b289",
"appDeployInstVersionUuid": "814b2d31684e4186aedf3faee2736872"
}
]
]
}
]
]
}
响应示例
{
"statusCode": 2000,
"message": "成功",
"returnObj": {
"planBatchUuid": "cfe8c62e3a1a4b80bb7eb841254bd05c"
}
}
状态码
请参考 状态码
错误码
请参考 错误码
