租户端 互联网中间件 微服务框架（TSF） 部署组相关接口 部署容器应用

部署容器应用

最近更新时间: 2024-10-18 10:38:41

1. 接口描述

接口请求域名： tsf.api3.fincloud.tencent.cn。

部署容器应用

默认接口请求频率限制：20次/秒。

接口更新时间：2022-08-02 21:01:14。

接口只验签名不鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：DeployContainerGroup
Version 是 否 String 公共参数，本接口取值：2018-03-26
Region 是 否 String 公共参数，详见产品支持的地域列表(TODO)
GroupId 是 否 String 部署组ID，分组唯一标识
Server 否 否 String 镜像server
Reponame 否 否 String 旧版镜像名，如/tsf/nginx
TagName 是 否 String 镜像版本名称,如v1
CpuLimit 否 否 String 业务容器最大的 CPU 核数，对应 K8S 的 limit；不填时默认为 request 的 2 倍
MemLimit 否 否 String 业务容器最大的内存 MiB 数，对应 K8S 的 limit；不填时默认为 request 的 2 倍
InstanceNum 是 否 Int64 实例数量
JvmOpts 否 否 String jvm参数
CpuRequest 否 否 String 业务容器分配的 CPU 核数，对应 K8S 的 request
MemRequest 否 否 String 业务容器分配的内存 MiB 数，对应 K8S 的 request
DoNotStart 否 否 Bool 是否不立即启动
RepoName 否 否 String （优先使用）新版镜像名，如/tsf/nginx
UpdateType 否 否 Int64 更新方式：0:快速更新 1:滚动更新
UpdateIvl 否 否 Int64 滚动更新必填，更新间隔
AgentCpuRequest 否 否 String agent 容器分配的 CPU 核数，对应 K8S 的 request
AgentCpuLimit 否 否 String agent 容器最大的 CPU 核数，对应 K8S 的 limit
AgentMemRequest 否 否 String agent 容器分配的内存 MiB 数，对应 K8S 的 request
AgentMemLimit 否 否 String agent 容器最大的内存 MiB 数，对应 K8S 的 limit
IstioCpuRequest 否 否 String istioproxy 容器分配的 CPU 核数，对应 K8S 的 request
IstioCpuLimit 否 否 String istioproxy 容器最大的 CPU 核数，对应 K8S 的 limit
IstioMemRequest 否 否 String istioproxy 容器分配的内存 MiB 数，对应 K8S 的 request
IstioMemLimit 否 否 String istioproxy 容器最大的内存 MiB 数，对应 K8S 的 limit
MaxSurge 否 否 String kubernetes滚动更新策略的MaxSurge参数
MaxUnavailable 否 否 String kubernetes滚动更新策略的MaxUnavailable参数
HealthCheckSettings 否 否 HealthCheckSettings 健康检查配置信息，若不指定该参数，则默认不设置健康检查。
Envs 否 否 Array of Env 部署组应用运行的环境变量。若不指定该参数，则默认不设置额外的环境变量。
ServiceSetting 否 否 ServiceSetting 容器部署组的网络设置。
DeployAgent 否 否 Bool 是否部署 agent 容器。若不指定该参数，则默认不部署 agent 容器。
SchedulingStrategy 否 否 SchedulingStrategy 节点调度策略。若不指定改参数，则默认不使用节点调度策略。
RepoType 否 否 String 仓库类型
SecretName 否 否 String secret 名称
VolumeInfoList 否 否 Array of VolumeInfo 数据卷信息，list
VolumeMountInfoList 否 否 Array of VolumeMountInfo 数据卷挂载点信息
VolumeClean 否 否 Bool 是否清除数据卷信息
VolumeInfos 否 否 Array of VolumeInfo 数据卷信息，list
VolumeMountInfos 否 否 Array of VolumeMountInfo 数据卷挂载点信息

3. 输出参数

参数名称 类型 描述
Result Bool 此参数对外不可见。
部署容器应用是否成功。<br>true：成功。<br>false：失败。
RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码 描述
InvalidParameterValue.ContainergroupUpdateivlInvalid
InvalidParameterValue.ContainergroupProtocolInvalid
InternalError.ContainergroupKuberneteApiInvokeError
InvalidParameterValue.ImagerepoReponameInvalid
InvalidParameter.ParamError
ResourceNotFound.ClusterNotExist
InvalidParameter.KubernetesParamError
InvalidParameter.BadRequest
UnauthorizedOperation.NoPrivilege
FailedOperation.ClusterQueryFailed
InternalError.UnhandledException
InvalidParameterValue.ContainergroupAccesstypeNull
InvalidParameterValue.ContainergroupCpulimitOver
InvalidParameterValue.ContainergroupGroupidNull
InvalidParameterValue.ContainergroupInvalidCpuInfo
InvalidParameterValue.ContainergroupInvalidMemInfo
InvalidParameterValue.ContainergroupMemlimitOver
InvalidParameterValue.ContainergroupNodePortInvalid
InvalidParameterValue.ContainergroupPortsRepeat
InvalidParameterValue.ContainergroupProtocolPortsNull
InvalidParameterValue.ContainergroupReponameInvalid
InvalidParameterValue.ContainergroupResourceAgentValueInvalid
InvalidParameterValue.ContainergroupTargetPortsRepeat
InvalidParameterValue.ImagerepoReponameNull
InvalidParameterValue.ImagerepoTagnameNull
ResourceNotFound.ContainergroupGroupNotFound
InvalidParameterValue.ContainergroupYamlUserContainerNotFound