接口功能介绍
调用getDeployConfig接口获取通用应用的镜像部署配置详情
接口约束
无
URI
GET /v1/image/deploy/configs/getDeployConfig
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
deployConfigId | 是 | String | 部署配置ID, 数据来源于部署配置列表的id属性值 |
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池ID,请参考调用前必知-概述 | bb9fdb42056f11eda1610242ac110002 |
请求体body参数
无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 响应编码 | 2000 | |
message | String | 消息内容 | ||
returnObj | Object | 返回对象 | returnObj | |
error | String | 调用错误时返回的错误编码 |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
appId | String | 应用ID | ||
createStaff | String | 创建人 | ||
createTime | String | 创建时间 | ||
deployEnvId | String | 部署环境ID | ||
deployEnvName | String | 部署环境名称 | ||
envVariableList | Array of Strings | 环境变量 | envVariableList | |
id | String | 部署配置ID | ||
lifeCycleMgt | String | 生命周期管理 | lifeCycleMgt | |
name | String | 部署配置名称 | ||
podResourceSpec | String | 单Pod资源规格 | podResourceSpec | |
startCommand | String | 启动命令 | startCommand | |
tenantId | Integer | 租户ID | 0 | |
updateStaff | String | 更新人 | ||
updateTime | String | 更新时间 |
表 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
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
headerList | Array of Strings | 请求头 | headerList | |
host | String | 主机 | ||
path | String | 路径 | ||
port | Integer | 端口 | 0 | |
scheme | String | 模式(协议),填写内容为:HTTP/HTTPS |
表 headerList
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
name | String | 名称 | ||
value | String | 值 |
表 tcpSocket
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
host | String | 主机 | ||
port | Integer | 端口 | 0 |
表 readiness
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
enabled | Boolean | 是否开启 | ||
exec | Object | 执行命令 | ||
failureThreshold | Integer | 失败阈值 | 0 | |
httpGet | String | 执行http GET请求 | ||
initialDelaySeconds | Integer | 初始延迟检测时间 | 0 | |
mode | String | 模式,填写内容为:EXEC,HTTP_GET,TCP_SOCKET | ||
periodSeconds | Integer | 探测周期 | 0 | |
successThreshold | Integer | 成功阈值 | 0 | |
tcpSocket | Object | 检测tcp端口 |
表 podResourceSpec
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
cpuLimit | Float | cpu下限 | 0 | |
cpuRequest | Float | cpu上限 | 0 | |
memoryLimit | Integer | 内存下限 | 0 | |
memoryRequest | Integer | 内存上限 | 0 |
表 startCommand
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
command | String | 命令 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
无
响应示例
{
"statusCode":2000,
"message":"成功",
"returnObj":{
"id":"test_9e554a2f0e61",
"name":"test_7341b967464b",
"deployEnvId":"test_9d5caa22a3a4",
"appId":"test_5044f313f1c9",
"tenantId":96,
"createTime":"2029-01-23 05: 56: 35",
"createStaff":"test_d8ceb00a4836",
"updateTime":"2014-09-20 20: 56: 44",
"updateStaff":"test_99590465f847",
"deployEnvName":"test_1e8fcae57417",
"podResourceSpec":{
"cpuLimit":85,
"cpuRequest":45,
"memoryLimit":89,
"memoryRequest":41
},
"startCommand":{
"command":"test_7875f6984c80",
"args":[
"test_283275a01275"
]
},
"envVariableList":[
{
"type":"test_879f38287b80",
"name":"test_57087f341a0d",
"value":"test_71346300e308"
}
],
"lifeCycleMgt":{
"liveness":{
"enabled":true,
"initialDelaySeconds":97,
"periodSeconds":83,
"successThreshold":39,
"timeoutSeconds":54,
"failureThreshold":41,
"mode":"test_222874d0db44",
"exec":{
"command":[
"test_088b126ad7ed"
]
},
"httpGet":{
"host":"test_1f218e448bbc",
"path":"test_4fb6a6197e0c",
"port":54,
"scheme":"test_57ea0a65c074",
"headerList":[
{
"name":"test_b7940802afdf",
"value":"test_498a2c185b34"
}
]
},
"tcpSocket":{
"host":"test_c1b7f93ba70b",
"port":10
}
},
"readiness":{
"enabled":true,
"initialDelaySeconds":56,
"periodSeconds":78,
"successThreshold":36,
"timeoutSeconds":5,
"failureThreshold":70,
"mode":"test_65a4d033c996",
"exec":{
"command":[
"test_b0f8ca8ee9dd"
]
},
"httpGet":{
"host":"test_ff31590e94cb",
"path":"test_4e47e91a6ba3",
"port":98,
"scheme":"test_c8b68bd4165b",
"headerList":[
{
"name":"test_590be96afa4f",
"value":"test_8b6175086727"
}
]
},
"tcpSocket":{
"host":"test_9012f615aa3b",
"port":84
}
}
}
}
}
状态码
请参考 状态码
错误码
请参考 错误码