操作指南

API 文档

部署容器应用

最近更新时间:2020-09-24 08:06:35

1. 接口描述

接口请求域名: tsf.tencentcloudapi.com 。

部署容器应用

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:tsf.ap-shanghai-fsi.tencentcloudapi.com。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DeployContainerGroup。
Version String 公共参数,本接口取值:2018-03-26。
Region String 公共参数,详见产品支持的 地域列表
GroupId String 部署组ID,分组唯一标识
TagName String 镜像版本名称,如v1
InstanceNum Integer 实例数量
Server String 镜像server
Reponame String 旧版镜像名,如/tsf/nginx
CpuLimit String 业务容器最大的 CPU 核数,对应 K8S 的 limit;不填时默认为 request 的 2 倍
MemLimit String 业务容器最大的内存 MiB 数,对应 K8S 的 limit;不填时默认为 request 的 2 倍
JvmOpts String jvm参数
CpuRequest String 业务容器分配的 CPU 核数,对应 K8S 的 request
MemRequest String 业务容器分配的内存 MiB 数,对应 K8S 的 request
DoNotStart Boolean 是否不立即启动
RepoName String (优先使用)新版镜像名,如/tsf/nginx
UpdateType Integer 更新方式:0:快速更新 1:滚动更新
UpdateIvl Integer 滚动更新必填,更新间隔
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.N Array of Env 部署组应用运行的环境变量。若不指定该参数,则默认不设置额外的环境变量。
ServiceSetting ServiceSetting 容器部署组的网络设置。
DeployAgent Boolean 是否部署 agent 容器。若不指定该参数,则默认不部署 agent 容器。

3. 输出参数

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

4. 示例

示例1 部署容器应用

输入示例

https://tsf.tencentcloudapi.com/?Action=DeployContainerGroup
&GroupId=group-xxxxxxx
&CpuRequest=0.54
&MemRequest=1024
&Server=ccr.ccs.tencentyun.com
&RepoName=tsf_10000617xxxx/test
&TagName=xxxx
&DoNotStart=false
&InstanceNum=1
&JvmOpts=-Xms128m-Xmx512m-XX:MetaspaceSize=128m-XX:MaxMetaspaceSize=512m
&UpdateType=1
&UpdateIvl=10
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "b481cffd-6b00-463f-a1ae-7afe5fd5fa2e",
    "Result": true
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
InternalError.ContainergroupKuberneteApiInvokeError 访问K8S集群-Api错误。
InvalidParameter.BadRequest 请求参数错误。
InvalidParameter.KubernetesParamError 参数错误。
InvalidParameter.ParamError 参数错误。
InvalidParameterValue.ContainergroupUpdateivlInvalid 更新间隔不能为空或者数值非法。
InvalidParameterValue.ImagerepoReponameInvalid 镜像仓库名不合法,示例:tsf-repo/nginx。
UnauthorizedOperation.NoPrivilege 无访问权限。
目录