接口功能介绍
调用deployK8sApplication接口部署K8s应用
接口约束
无
URI
POST /v1/app/inst/deployK8sApplication
路径参数
无
Query参数
无
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池ID,请参考调用前必知-概述 | bb9fdb42056f11eda1610242ac110002 |
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
appId | 是 | String | 应用ID | ||
deployEnvId | 是 | String | 环境ID | ||
deploySource | 是 | String | 部署来源,数据可为: CODE(源码), PACKAGE(制品), IMAGE(镜像) | ||
runtimeEnvCode | 否 | String | 运行环境,源码,官方DEMO或制品时必填 | ||
runtimeEnvVer | 否 | String | 运行环境版本号,源码,官方DEMO或制品时必填 | ||
packageSource | 否 | String | 制品来源, 当部署来源:官方DEMO或制品时必填,数据可填为: USER_UPLOAD(用户上传),OFFICIAL_DEMO(官方DEMO),CODE_GENERATE(代码生成),EXISTED_PACKAGE(已存在制品) | ||
packageId | 否 | String | 制品ID,当部署来源:制品时必填; | ||
packageName | 否 | String | 程序包名称,当部署来源:源码或制品时必填 | ||
packageVer | 否 | String | 制品版本,源码,官方DEMO或制品时必填 | ||
officialDemoCode | 否 | String | 官方demo,当部署来源:制品且制品为官方DEMO时必填 | ||
branchOrTagName | 否 | String | 分支tag名称,当部署来源:源码时必填 | ||
buildEnvCode | 否 | String | 编译环境,当部署来源:源码时必填 | ||
packagePath | 否 | String | 程序包路径,当部署来源:源码时必填 | ||
deployVer | 是 | String | 部署版本号 | ||
podNum | 是 | Integer | K8s pod数量 | 0 | |
msManagement | 否 | Object | 服务注册 | msManagement | |
podResourceSpec | 是 | Object | 单Pod资源配额 | podResourceSpec | |
startCommand | 否 | Object | 启动命令 | startCommand | |
envVariableList | 否 | Array of Objects | 环境变量 | envVariableList | |
lifeCycleMgt | 否 | Object | 应用健康检查 | lifeCycleMgt | |
logConfigList | 否 | Array of Objects | 日志收集 | logConfigList | |
configMgtList | 否 | Array of Objects | 配置管理 | configMgtList | |
deploymentStrategy | 否 | Object | 灰度部署策略 | deploymentStrategy | |
imageUrl | 否 | String | 镜像地址,镜像部署时必填,数据来源于CR镜像仓库控制台 | ||
imageName | 否 | String | 镜像名称,镜像部署时必填,数据来源于CR镜像仓库控制台 | ||
imageVer | 否 | String | 镜像版本,镜像部署时必填,数据来源于CR镜像仓库控制台 | ||
namespace | 否 | String | 镜像命名空间,镜像部署时必填,数据来源于CR镜像仓库控制台 | ||
instanceId | 否 | Long | 镜像仓库实例ID,镜像部署时必填,数据来源于CR镜像仓库控制台 | ||
repositoryId | 否 | Long | 仓库ID,镜像部署时必填,数据来源于CR镜像仓库控制台 | ||
imageSecret | 否 | String | 镜像仓库秘钥,在镜像部署切仓库类型为私有类型时必填,数据来源于CR镜像仓库控制台 |
表 msManagement
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
registerCenterInstId | 否 | String | 注册中心实例ID,在使用注册中心时必填 | ||
enabled | 否 | Boolean | 是否开启无损上下线 | false | |
warmupTime | 否 | Integer | 预热时长,单位为秒, 0-86400 | 0 | |
funcType | 否 | Integer | 预热曲线类型, 0-20 | 0 | |
delayTime | 否 | Integer | 延迟注册时间,单位为秒, 0-86400 | 0 | |
aligned | 否 | Boolean | 通过就绪检查前完成服务注册 | false | |
related | 否 | Boolean | 通过就绪检查前完成服务预热 | false |
表 podResourceSpec
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
cpuLimit | 是 | Float | cpu上限 | 0 | |
cpuRequest | 是 | Float | cpu下限 | 0 | |
memoryLimit | 是 | Integer | 内存上限 | 0 | |
memoryRequest | 是 | Integer | 内存下限 | 0 |
表 startCommand
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
command | 否 | String | 启动命令 | ||
args | 否 | Array of Strings | 应用类型,数据可为EXTERNAL_CODE(源码),PACKAGE(制品) |
表 envVariableList
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
type | 否 | String | 变量类型,限自定义COMMON_ENV_VAR、配置项K8S_CONFIG_MAP_ENV_VAR、保密字典K8S_SECRET_ENV_VAR | ||
name | 否 | String | 变量名 | ||
value | 否 | String | 变量值 | ||
referenceName | 否 | String | 当type为配置项K8S_CONFIG_MAP_ENV_VAR或者保密字典K8S_SECRET_ENV_VAR时,该参数必填;当type为自定义COMMON_ENV_VAR时,该参数非必填 |
表 lifeCycleMgt
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
liveness | 否 | Object | liveness配置 | liveness | |
readiness | 否 | Object | readiness配置 | readiness |
表 liveness
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
enabled | 否 | Boolean | 是否开启 | false | |
initialDelaySeconds | 否 | Integer | 初始化延迟时间 | 0 | |
periodSeconds | 否 | Integer | 间隔时间 | 0 | |
successThreshold | 否 | Integer | 成功次数 | 0 | |
timeoutSeconds | 否 | Integer | 超时时间 | 0 | |
failureThreshold | 否 | Integer | 失败次数 | 0 | |
mode | 否 | String | 模式,数据可为EXEC,HTTP_GET,TCP_SOCKET | ||
exec | 否 | Object | exec模式 | exec | |
httpGet | 否 | Object | httpGet模式 | httpGet | |
tcpSocket | 否 | Object | tcpSocket模式 | tcpSocket |
表 exec
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
command | 否 | Array of Strings | 启动命令 |
表 httpGet
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
host | 否 | String | 主机地址 | ||
path | 否 | String | 路径 | ||
port | 否 | Integer | 主机端口 | 0 | |
scheme | 否 | String | 请求协议,可为HTTP和HTTPS | ||
headerList | 否 | Array of Objects | HttpHeaders | httpHeadersList |
表 httpHeadersList
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
name | 否 | String | HttpHeaders名称 | ||
value | 否 | String | HttpHeaders值 |
表 tcpSocket
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
host | 否 | String | 主机地址 | ||
port | 否 | Integer | 端口 | 0 |
表 readiness
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
enabled | 否 | Boolean | 是否开启 | false | |
initialDelaySeconds | 否 | Integer | 初始化延迟时间 | 0 | |
periodSeconds | 否 | Integer | 间隔时间 | 0 | |
successThreshold | 否 | Integer | 成功次数 | 0 | |
timeoutSeconds | 否 | Integer | 超时时间 | 0 | |
failureThreshold | 否 | Integer | 失败次数 | 0 | |
mode | 否 | String | 模式,数据可为EXEC,HTTP_GET,TCP_SOCKET | ||
exec | 否 | Object | exec模式 | exec | |
httpGet | 否 | Object | httpGet模式 | httpGet | |
tcpSocket | 否 | Object | tcpSocket模式 | tcpSocket |
表 logConfigList
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
logProject | 否 | String | 暂无描述 | ||
logStore | 否 | String | 日志存储路径 | ||
logType | 否 | String | 采集日志类型,数据可为stdout:标准输出;applog:文件日志 | ||
logDir | 否 | String | 日志路径 | ||
createTime | 否 | String | 创建时间 | 2022-11-17 17:28:26 |
表 configMgtList
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
configType | 否 | String | 配置类型,目前默认只支持配置项CONFIG_MAP | ||
fileMountType | 否 | String | 文件挂载方式,默认现在只有覆盖方式 | ||
mountConfigList | 否 | Array of Objects | 指定配置项下各文件的挂载 | mountConfigList | |
mountMasterDir | 否 | String | 挂载主目录 | ||
mountSource | 否 | String | 挂载源,目前默认就是获取配置项名称 | ||
mountType | 否 | String | 挂载类型, 目前默认只支持挂载到文件MOUNT_FILE |
表 mountConfigList
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
name | 否 | String | 配置项文件名称 | ||
mountPath | 否 | String | 配置项文件挂载路径 |
表 deploymentStrategy
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
batchList | 否 | Array of Objects | 批次列表 | batchList | |
betweenBatchProcessingMode | 否 | String | 批次间处理方式,分为自动AUTO和手动MANUAL,目前只能为MANUAL | ||
batchWaitTime | 否 | Integer | 批次间隔时间,自动时才会填写 | 0 | |
grayUpdate | 否 | Boolean | 是否灰度 | false | |
grayRule | 否 | Object | 灰度规则 | grayRule |
表 batchList
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
batchSeq | 否 | Integer | 批次序号 | 0 | |
instNum | 否 | Integer | 批次实例数 | 0 |
表 grayRule
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
content | 否 | Object | 内容灰度 | content | |
grayType | 否 | String | 灰度类型,数据只能为PERCENT和CONTENT | ||
percent | 否 | Array of Objects | 流量灰度 | percent |
表 percent
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
rate | 否 | Integer | 流量灰度比例 | 0 | |
tag | 否 | String | 流量灰度标签 |
表 content
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
carryData | 否 | Boolean | 是否链路传递 | ||
ruleName | 否 | String | 规则名 | ||
rules | 否 | Array of Objects | 灰度内容规则 | rules | |
tag | 否 | String | 标签名 |
表 rules
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
condition | 否 | String | 条件模式AND-同时满足 OR-任一 | ||
conditions | 否 | Array of Objects | 暂无描述 | conditions | |
path | 否 | String | 请求路径serviceType=springCloud属性必填 | ||
serviceType | 否 | String | 框架类型springcloud和Dubbo |
表 conditions
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
cond | 否 | String | =、!=、>、<、>=、<=、%、in、mod、regexp | ||
expr | 否 | String | serviceType=Dubbo属性必填 | ||
index | 否 | Integer | serviceType=Dubbo属性必填 | 0 | |
operator | 否 | String | cond=mod必填,=、!=、>、<、>=、<= | ||
param | 否 | String | serviceType=springCloud属性必填 | ||
type | 否 | String | serviceType=springCloud属性必填,cookie、header、param、body | ||
value | 否 | String | cond=in时多个以逗号隔开 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 响应编码 | 2000 | |
message | String | 消息内容 | ||
returnObj | Object | 返回对象 | ||
error | String | 调用错误时返回的错误编码 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"appId": "",
"deployEnvId": "",
"deploySource": "",
"runtimeEnvCode": "",
"runtimeEnvVer": "",
"packageSource": "",
"packageId": "",
"packageName": "",
"packageVer": "",
"officialDemoCode": "",
"branchOrTagName": "",
"buildEnvCode": "",
"packagePath": "",
"deployVer": "",
"podNum": 0,
"msManagement": {
"registerCenterInstId": "",
"enabled": false,
"warmupTime": 0,
"funcType": 0,
"delayTime": 0,
"aligned": false,
"related": false
},
"podResourceSpec": {
"cpuLimit": 0,
"cpuRequest": 0,
"memoryLimit": 0,
"memoryRequest": 0
},
"startCommand": {
"command": "",
"args": [
""
]
},
"envVariableList": [
{
"type": "",
"name": "",
"value": ""
}
],
"lifeCycleMgt": {
"liveness": {
"enabled": false,
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"timeoutSeconds": 0,
"failureThreshold": 0,
"mode": "",
"exec": {
"command": [
""
]
},
"httpGet": {
"host": "",
"path": "",
"port": 0,
"scheme": "",
"headerList": [
{
"name": "",
"value": ""
}
]
},
"tcpSocket": {
"host": "",
"port": 0
}
},
"readiness": {
"enabled": false,
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"timeoutSeconds": 0,
"failureThreshold": 0,
"mode": "",
"exec": {
"command": [
""
]
},
"httpGet": {
"host": "",
"path": "",
"port": 0,
"scheme": "",
"headerList": [
{
"name": "",
"value": ""
}
]
},
"tcpSocket": {
"host": "",
"port": 0
}
}
},
"logConfig": {
"logProject": "",
"logStore": "",
"logType": "",
"logDir": "",
"createTime": "2022-11-17 17:28:26"
},
"configMgtList": [
{
"configType": "",
"mountType": "",
"mountSource": "",
"mountMasterDir": "",
"fileMountType": "",
"mountConfigList": [
{
"name": "",
"mountPath": ""
}
]
}
],
"deploymentStrategy": {
"batchList": [
{
"batchSeq": 0,
"instNum": 0
}
],
"betweenBatchProcessingMode": "",
"batchWaitTime": 0,
"grayUpdate": false,
"grayRule": {
"grayType": "",
"percent": [
{
"tag": "",
"rate": 0
}
],
"content": {
"ruleName": "",
"tag": "",
"carryData": false,
"rules": [
{
"serviceType": "",
"path": "",
"condition": "",
"conditions": [
{
"index": 0,
"expr": "",
"type": "",
"param": "",
"cond": "",
"value": "",
"operator": ""
}
]
}
]
}
}
}
}
响应示例
{"statusCode":"2000","returnObj":{"appId":"xxx","changeOrderId":"xxx"},"message":"成功"}
状态码
请参考 状态码
错误码
请参考 错误码