操作指南

API 文档

创建容器部署组

最近更新时间:2020-11-30 11:37:54

我的收藏

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 公共参数,本接口取值:CreateContainGroup。
Version String 公共参数,本接口取值:2018-03-26。
Region String 公共参数,详见产品支持的 地域列表
ApplicationId String 分组所属应用ID
NamespaceId String 分组所属命名空间ID
GroupName String 分组名称字段,长度1~60,字母或下划线开头,可包含字母数字下划线
InstanceNum Integer 实例数量
AccessType Integer 0:公网 1:集群内访问 2:NodePort
ProtocolPorts.N Array of ProtocolPort 数组对象,见下方定义
ClusterId String 集群ID
CpuLimit String 最大分配 CPU 核数,对应 K8S limit
MemLimit String 最大分配内存 MiB 数,对应 K8S limit
GroupComment String 分组备注字段,长度应不大于200字符
UpdateType Integer 更新方式:0:快速更新 1:滚动更新
UpdateIvl Integer 滚动更新必填,更新间隔
CpuRequest String 初始分配的 CPU 核数,对应 K8S request
MemRequest String 初始分配的内存 MiB 数,对应 K8S request
GroupResourceType String 部署组资源类型
SubnetId String 子网ID
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

3. 输出参数

参数名称 类型 描述
Result String 返回创建成功的部署组ID,返回null表示失败
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建容器部署组

创建容器部署组

输入示例

https://tsf.tencentcloudapi.com/?Action=CreateContainGroup
&CpuRequest=0.25
&MemRequest=128
&InstanceNum=1
&ApplicationId=application-xxxxxxx
&GroupName=consumer
&NamespaceId=namespace-xxxxxxx
&ClusterId=cls-xxxxxxx
&AccessType=2
&ProtocolPorts.0.Protocol=TCP
&ProtocolPorts.0.Port=90
&ProtocolPorts.0.TargetPort=90
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "39bb8e88-1ccd-4204-9f9e-56804c980a31",
    "Result": "group-xxxxxxx"
  }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InvalidParameter.ParamError 参数错误。
InvalidParameterValue.ContainergroupGroupnameRegexMatchFalse 部署组名称格式不正确。
InvalidParameterValue.ContainergroupInvalidCpuInfo CPU limit 和 request 不能同时为空。
InvalidParameterValue.ContainergroupInvalidMemInfo 内存 limit 和 request 不能同时为空。
InvalidParameterValue.ContainergroupNodePortInvalid 主机端口值非法。
InvalidParameterValue.ContainergroupPortInvalid 服务端口值非法。
InvalidParameterValue.ContainergroupProtocolInvalid 协议值非法,限定:TCP/UDP。
InvalidParameterValue.GroupNameExist 分组名称已存在,请更换其他名称。
ResourceNotFound.GroupApplicationNotExist 应用不存在。
ResourceNotFound.GroupNamespaceNotExist 命名空间不存在。
目录