1. 接口描述
接口请求域名: tsf.tencentcloudapi.com 。
(已废弃,请使用 CreateGroup 和 DeployContainerGroup 创建和部署容器部署组)创建容器部署组
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateContainGroup。 |
Version | 是 | String | 公共参数,本接口取值:2018-03-26。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ApplicationId | 是 | String | 分组所属应用ID 示例值:application-xxxxxxx |
NamespaceId | 是 | String | 分组所属命名空间ID 示例值:namespace-xxxxxxx |
GroupName | 是 | String | 分组名称字段,长度1~60,字母或下划线开头,可包含字母数字下划线 示例值:consumer |
InstanceNum | 是 | Integer | 实例数量 示例值:1 |
AccessType | 是 | Integer | 0:公网 1:集群内访问 2:NodePort 示例值:2 |
ProtocolPorts.N | 是 | Array of ProtocolPort | 数组对象,见下方定义 |
ClusterId | 是 | String | 集群ID 示例值:cls-xxxxxxx |
CpuLimit | 否 | String | 最大分配 CPU 核数,对应 K8S limit |
MemLimit | 否 | String | 最大分配内存 MiB 数,对应 K8S limit |
GroupComment | 否 | String | 分组备注字段,长度应不大于200字符 |
UpdateType | 否 | Integer | 更新方式:0:快速更新 1:滚动更新 |
UpdateIvl | 否 | Integer | 滚动更新必填,更新间隔 |
CpuRequest | 否 | String | 初始分配的 CPU 核数,对应 K8S request 示例值:0.25 |
MemRequest | 否 | String | 初始分配的内存 MiB 数,对应 K8S request 示例值:128 |
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表示失败 示例值:group-xxxxxxx |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 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(已废弃,请使用 CreateGroup 和 DeployContainerGroup 创建和部署容器部署组)"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError.ContainergroupSqlFailed | 容器应用SQL错误。 |
InternalError.GroupMasterNuknownError | 部署组操作请求MASTER 操作失败。 |
InvalidParameter.ParamError | 参数错误。 |
InvalidParameterValue.ContainergroupApplicationIdNull | 所属应用ID不能为空。 |
InvalidParameterValue.ContainergroupGroupnameLegnth | 部署组名不能大于60个字符。 |
InvalidParameterValue.ContainergroupGroupnameNull | 部署组名不能为空。 |
InvalidParameterValue.ContainergroupGroupnameRegexMatchFalse | 部署组名称格式不正确,只能包含小写字母、数字及分隔符("-"),且必须以小写字母开头,数字或小写字母结尾。 |
InvalidParameterValue.ContainergroupInvalidCpuInfo | CPU limit 和 request 不能同时为空。 |
InvalidParameterValue.ContainergroupInvalidMemInfo | 内存 limit 和 request 不能同时为空。 |
InvalidParameterValue.ContainergroupNodePortInvalid | 主机端口值非法。 |
InvalidParameterValue.ContainergroupPortInvalid | 服务端口值非法。 |
InvalidParameterValue.ContainergroupProtocolInvalid | 协议值非法,限定:TCP/UDP。 |
InvalidParameterValue.ContainergroupProtocolNull | 协议不能为空。 |
InvalidParameterValue.ContainergroupProtocolPortsNull | 协议端口不能为空。 |
InvalidParameterValue.ContainergroupTargetportNull | 容器端口不能为空。 |
InvalidParameterValue.ContainergroupUpdateivlInvalid | 更新间隔不能为空或者数值非法。 |
InvalidParameterValue.GroupClusterNamespaceNotBound | 部署组的集群未绑定该命名空间。 |
InvalidParameterValue.GroupClusterTypeMismatch | 创建分组, 集群类型不匹配。 |
InvalidParameterValue.GroupNameExist | 部署组名称已存在,请更换其他名称。 |
ResourceNotFound.ContainergroupClusterNotfound | 找不到集群。 |
ResourceNotFound.GroupApplicationNotExist | 无法获取分组所属应用。 |
ResourceNotFound.GroupNamespaceNotExist | 无法获取分组所属命名空间。 |