创建容器部署组

最近更新时间:2019-08-29 21:04:26

1. 接口描述

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

创建容器部署组

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

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

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

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 Explorer

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

SDK

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

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码