部署容器应用

最近更新时间: 2026-07-12 00:20:53

1. 接口描述

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

部署容器应用-更新

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

接口更新时间：2025-09-10 17:02:35。

接口既验签名又鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DeployContainerGroup
Version	是	否	String	公共参数，本接口取值：2018-03-26
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
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，默认0.25 示例值：
MemRequest	否	否	String	业务容器分配的内存 MiB 数，对应 K8S 的 request，默认640 MiB 示例值：
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	节点调度策略。若不指定改参数，则默认不使用节点调度策略。示例值：查看
IncrementalDeployment	否	否	Bool	是否进行增量部署，默认为false，全量更新示例值：
RepoType	否	否	String	tcr或者不填示例值：
VolumeInfos	否	否	Array of VolumeInfo	数据卷信息-废弃，请用VolumeInfoList参数示例值：查看
VolumeMountInfos	否	否	Array of VolumeMountInfo	数据卷挂载点信息-废弃，请用VolumeMountInfoList参数示例值：查看
VolumeInfoList	否	否	Array of VolumeInfo	数据卷信息，list 示例值：查看
VolumeMountInfoList	否	否	Array of VolumeMountInfo	数据卷挂载点信息，list 示例值：查看
VolumeClean	否	否	Bool	是否清除数据卷信息，默认false 示例值：
AgentProfileList	否	否	Array of AgentProfile	javaagent信息: SERVICE_AGENT/OT_AGENT 示例值：查看
WarmupSetting	否	否	WarmupSetting	预热配置信息示例值：查看
GatewayConfig	否	否	GatewayConfig	Envoy网关服务配置示例值：查看
SecretName	否	否	String	镜像秘钥示例值：
ContainerKind	否	否	String	容器负载类型示例值：
StaticIpEnabled	否	否	Bool	是否启用静态IP 示例值：
PodManagementPolicyType	否	否	String	启动策略示例值：
Partition	否	否	Int64	滚动更新分区序号示例值：
ImagePullSecretList	否	否	Array of String	镜像凭证列表示例值：
AdditionalContainerList	否	否	Array of ContainerInfo	附加容器列表示例值：查看
InitContainerEnable	否	否	Bool	是否为初始化容器示例值：

3. 输出参数

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

4. 错误码

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

错误码	描述
InvalidParameter.ParamError	参数错误。
InvalidParameterValue.ContainergroupPortsRepeat	服务端口不允许重复映射。
InvalidParameterValue.ImagerepoRepoNameNull	镜像仓库名不能为空。
InvalidParameterValue.ContainergroupTargetPortsRepeat	容器端口不允许重复映射。
InvalidParameterValue.ContainergroupYamlUserContainerNotFound	找不到业务容器。
MissingParameter.SystemParameterRequired	未指定%s。。
InvalidParameterValue.ContainergroupProtocolPortsNull	协议端口不能为空。
InternalError.ContainergroupKuberneteApiInvokeError	访问TKE服务失败。
InvalidParameterValue.ContainergroupTargetportNull	容器端口不能为空。
InternalError.ContainergroupSqlFailed	容器应用SQL错误。
InvalidParameterValue.ContainergroupCpulimitOver	集群 CPU 资源不足。
InvalidParameterValue.ContainergroupProtocolInvalid	协议值非法,限定:TCP/UDP。
InternalError.ContainergroupKuberneteConnectError	连接TKE服务失败。
InvalidParameterValue.ContainergroupProtocolMixError	公网访问方式下，协议需要一致。
InvalidParameterValue.ContainergroupProtocolNull	协议不能为空。
InvalidParameterValue.ContainergroupNodePortInvalid	主机端口值非法。
InvalidParameterValue.ImagerepoReponameInvalid	镜像仓库名不合法,示例:tsf-repo/nginx。
FailedOperation.UnhandledException	模块未处理异常。
ResourceNotFound.ContainergroupGroupNotFound	无法找到该部署组。
InternalError.UnhandledException	[%s]模块未处理异常。。
InvalidParameterValue.ContainergroupGroupidNull	部署组ID不能为空。
InvalidParameterValue.ContainergroupAccesstypeNull	服务访问方式不能为空。
ResourceNotFound.MicroserviceOffline	目标微服务已离线[%s]。。
ResourceNotFound.ClusterNotExist	无法获取命名空间所属集群。
InvalidParameterValue.ContainergroupResourceAgentValueInvalid	agent 容器资源值非法 , %s。
InvalidParameterValue.ContainergroupUpdateivlInvalid	更新间隔不能为空或者数值非法。
InvalidParameterValue.WrongDontStartValue	仅有停止状态下的部署组才可以不启动。
FailedOperation.ClusterQueryFailed	查询集群失败。
InvalidParameterValue.ContainergroupInvalidMemInfo	内存 limit 和 request 不能同时为空。
UnauthorizedOperation.NoPrivilege	用户无权限访问该接口。。
FailedOperation.TsfPrivilegeError	TSF权限模块异常，请联系系统管理员。。
InvalidParameterValue.ContainergroupReponameInvalid	镜像仓库名与应用名不匹配。
InvalidParameterValue.ContainergroupInvalidCpuInfo	CPU limit 和 request 不能同时为空。
InvalidParameterValue.ContainergroupMemlimitOver	集群内存资源不足。
InvalidParameter.KubernetesParamError	参数错误。
InvalidParameterValue.ContainergroupUpdatetypeInvalid	updateType参数不合法，值必须为0、1。
InvalidParameterValue.ImagerepoTagnameNull	imageTags不能为空。
InvalidParameter.BadRequest	[%s]模块接口[%s]请求不正确（400 BAD REQUEST）。。
FailedOperation.ContainergroupKuberneteApiInvokeError	调用 kube-api-server 失败。