1. 接口描述
接口请求域名: tsf.api3.fincloud.tencent.com。
创建容器部署组
默认接口请求频率限制:20次/秒。
接口更新时间:2024-09-14 11:55:39。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:CreateContainGroup |
| Version | 是 | 否 | String | 公共参数,本接口取值:2018-03-26 |
| Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| ApplicationId | 是 | 否 | String | 分组所属应用ID 示例值: |
| NamespaceId | 是 | 否 | String | 分组所属命名空间ID 示例值: |
| GroupName | 是 | 否 | String | 分组名称字段,长度1~60,字母或下划线开头,可包含字母数字下划线 示例值: |
| CpuLimit | 否 | 否 | String | 最大分配 CPU 核数,对应 K8S limit 示例值: |
| MemLimit | 否 | 否 | String | 最大分配内存 MiB 数,对应 K8S limit 示例值: |
| InstanceNum | 是 | 否 | Int64 | 实例数量 示例值: |
| AccessType | 是 | 否 | Int64 | 0:公网 1:集群内访问 2:NodePort 示例值: |
| ProtocolPorts | 是 | 否 | Array of ProtocolPort | 数组对象,见下方定义 示例值:查看 |
| GroupComment | 否 | 否 | String | 分组备注字段,长度应不大于200字符 示例值: |
| UpdateType | 否 | 否 | Int64 | 更新方式:0:快速更新 1:滚动更新 示例值: |
| UpdateIvl | 否 | 否 | Int64 | 滚动更新必填,更新间隔 示例值: |
| ClusterId | 是 | 否 | String | 集群ID 示例值: |
| 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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue.ContainergroupUpdateivlInvalid | 更新间隔不能为空或者数值非法。 |
| InvalidParameterValue.ContainergroupProtocolInvalid | 协议值非法,限定:TCP/UDP。 |
| InvalidParameterValue.ContainergroupPortInvalid | 服务端口值非法。 |
| InvalidParameter.ParamError | 参数错误。 |
| InvalidParameterValue.GroupNameExist | 部署组名称已存在,请更换其他名称。 |
| InternalError.ContainergroupSqlFailed | 容器应用SQL错误。 |
| InternalError.GroupMasterNuknownError | 部署组操作请求MASTER 操作失败。 |
| InvalidParameterValue.ContainergroupApplicationIdNull | 所属应用ID不能为空。 |
| InvalidParameterValue.ContainergroupInvalidCpuInfo | CPU limit 和 request 不能同时为空。 |
| InvalidParameterValue.ContainergroupInvalidMemInfo | 内存 limit 和 request 不能同时为空。 |
| InvalidParameterValue.ContainergroupNodePortInvalid | 主机端口值非法。 |
| InvalidParameterValue.ContainergroupProtocolPortsNull | 协议端口不能为空。 |
| InvalidParameterValue.ContainergroupTargetportNull | 容器端口不能为空。 |
| InvalidParameterValue.GroupClusterNamespaceNotBound | 部署组的集群未绑定该命名空间。 |
| InvalidParameterValue.GroupClusterTypeMismatch | 创建分组, 集群类型不匹配。 |
| ResourceNotFound.ContainergroupClusterNotfound | 找不到集群。 |
| ResourceNotFound.GroupApplicationNotExist | 无法获取分组所属应用。 |
| ResourceNotFound.GroupNamespaceNotExist | 无法获取分组所属命名空间。 |
| InvalidParameterValue.ContainergroupGroupnameRegexMatchFalse | 部署组名称格式不正确,只能包含小写字母、数字及分隔符("-"),且必须以小写字母开头,数字或小写字母结尾。 |
| InvalidParameterValue.ContainergroupGroupnameNull | 部署组名不能为空。 |
| InvalidParameterValue.ContainergroupGroupnameLegnth | 部署组名不能大于60个字符。 |
| InvalidParameterValue.ContainergroupProtocolNull | 协议不能为空。 |