接口功能介绍
调用createDeployConfig新建通用应用镜像部署配置
接口约束
无
URI
POST /v1/image/deploy/configs/createDeployConfig
路径参数
无
Query参数
无
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池ID,请参考调用前必知-概述 | bb9fdb42056f11eda1610242ac110002 |
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
appId | 是 | String | 应用ID,数据来源于分页获取应用列表 | ||
deployEnvId | 是 | String | 部署环境ID,数据来源于环境列表 | ||
envVariableList | 否 | Array of Objects | 环境变量 | envVariableList | |
lifeCycleMgt | 否 | Object | 生命周期管理 | lifeCycleMgt | |
name | 是 | String | 部署配置名称 | ||
podResourceSpec | 是 | Object | 单Pod资源规格 | podResourceSpec | |
startCommand | 否 | Object | 启动命令 | startCommand |
表 envVariableList
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
name | 否 | String | 变量名称 | ||
type | 否 | String | 变量类型,只能填写COMMON_ENV_VAR | ||
value | 否 | String | 变量值 |
表 lifeCycleMgt
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
liveness | 否 | Object | 存活探针 | liveness | |
readiness | 否 | Object | 就绪探针 | readiness |
表 liveness
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
enabled | 否 | Boolean | 是否开启 | ||
exec | 否 | Object | 执行命令 | exec | |
failureThreshold | 否 | Integer | 失败阈值 | 0 | |
httpGet | 否 | Object | 执行http GET请求 | httpGet | |
initialDelaySeconds | 否 | Integer | 初始延迟检测时间 | 0 | |
mode | 否 | String | 模式,填写内容为:EXEC,HTTP_GET,TCP_SOCKET | ||
periodSeconds | 否 | Integer | 探测周期 | 0 | |
successThreshold | 否 | Integer | 成功阈值 | 0 | |
tcpSocket | 否 | Object | 检测tcp端口 | tcpSocket | |
timeoutSeconds | 否 | Integer | 超时时间 | 0 |
表 exec
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
command | 否 | Array of Strings | 命令列表 |
表 httpGet
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
host | 否 | String | 主机 | ||
path | 否 | String | 路径 | ||
port | 否 | String | 端口 | ||
scheme | 否 | String | 模式(协议),填写内容为:HTTP/HTTPS | ||
headerList | 否 | Array of Objects | 请求头 | headerList |
表 headerList
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
name | 否 | String | 名称 | ||
value | 否 | String | 值 |
表 tcpSocket
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
host | 否 | String | 主机 | ||
port | 否 | Integer | 端口 | 0 |
表 readiness
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
enabled | 否 | Boolean | 是否开启 | ||
exec | 否 | Object | 执行命令 | exec | |
failureThreshold | 否 | Integer | 失败阈值 | 0 | |
httpGet | 否 | Object | 执行http GET请求 | httpGet | |
initialDelaySeconds | 否 | Integer | 初始延迟检测时间 | 0 | |
mode | 否 | String | 模式,填写内容为:EXEC,HTTP_GET,TCP_SOCKET | ||
periodSeconds | 否 | Integer | 探测周期 | 0 | |
successThreshold | 否 | Integer | 成功阈值 | 0 | |
tcpSocket | 否 | Object | 检测tcp端口 | tcpSocket |
表 podResourceSpec
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
cpuLimit | 是 | Float | cpu上限 | 0 | |
cpuRequest | 是 | Float | cpu下限 | 0 | |
memoryLimit | 是 | Integer | 内存上限 | 0 | |
memoryRequest | 是 | Integer | 内存下限 | 0 |
表 startCommand
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
command | 否 | String | 命令 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 响应编码 | 2000 | |
message | String | 消息内容 | ||
returnObj | Object | 返回对象 | returnObj | |
error | String | 调用错误时返回的错误编码 |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
deployConfigId | String | 部署配置ID |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
"lifeCycleMgt": {
"readiness": {
"mode": "TCP_SOCKET",
"failureThreshold": 87,
"periodSeconds": 89,
"tcpSocket": {},
"initialDelaySeconds": 32,
"enabled": false,
"exec": {
"command": []
},
"httpGet": {
"headerList": []
}
},
"liveness": {
"mode": "TCP_SOCKET",
"failureThreshold": 5,
"periodSeconds": 25,
"tcpSocket": {
"port": 80
},
"timeoutSeconds": 14,
"successThreshold": 1,
"initialDelaySeconds": 1,
"exec": {
"command": []
},
"httpGet": {
"headerList": []
}
}
},
"envVariableList": [],
"appId": "06f80dcd-52b4-4574-a8f6-79a7e65f2363",
"podResourceSpec": {
"cpuLimit": 1,
"memoryRequest": 1024,
"memoryLimit": 1024,
"cpuRequest": 1
},
"name": "test1q1a1",
"startCommand": {},
"deployEnvId": "ff1ea4fb-180b-4be6-a74e-a05906be5c1b"
}
响应示例
{
"statusCode":2000,
"returnObj":{
"deployConfigId":"58a7af16-05cd-4834-86fe-a72dcc1e1e45"
},
"message":"成功"
}
状态码
请参考 状态码
错误码
请参考 错误码