创建部署组
最近更新时间: 2026-10-11 00:12:05
1. 接口描述
接口请求域名： tsf.api3.fincloud.tencent.com。
创建虚拟机部署组
默认接口请求频率限制：10000次/秒。
接口更新时间：2026-02-04 22:12:22。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：CreateGroup |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-03-26 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| NamespaceId | 是 | 否 | String | 部署组所属命名空间ID 示例值： namespace-6a79x94v |
| GroupName | 是 | 否 | String | 部署组名称 示例值： demo |
| ClusterId | 是 | 否 | String | 集群ID 示例值： cluster-6a79x94v |
| GroupDesc | 否 | 否 | String | 部署组描述 示例值： This is desc |
| GroupResourceType | 否 | 否 | String | 部署组资源类型；DEF 表示默认资源类型；GW 表示网关资源类型 示例值： "DEF": 使用时需要去掉双引号 |
| ApplicationId | 是 | 否 | String | 部署组所属的应用ID 示例值： application-6a79x94v |
| Alias | 否 | 否 | String | 部署组备注 示例值： 备注 |
| Tags | 否 | 是 | Array of Tag | 标签列表 示例值：查看 |
| K8sNamespaceName | 否 | 否 | String | k8s命名空间名称 示例值： default |
| UnitType | 否 | 否 | String | 单元类型 示例值： Global |
| UnitEnvType | 否 | 否 | String | 单元环境类型 示例值： Prod |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | String | groupId， null表示创建失败 示例值： group-6a79x94v |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue.GroupNameExist | 部署组名称已存在，请更换其他名称。 |
| InvalidParameterValue.GroupNameLength | 部署组名不能大于50个字符。 |
| InvalidParameterValue.GroupNameRegxMismatch | 部署组名称格式不正确,只能包含小写字母、数字及分隔符("-"),且必须以小写字母开头，数字或小写字母结尾。 |
| UnauthorizedOperation.NoPrivilege | 用户无权限访问该接口。。 |
| ResourceNotFound.CvmcaeMasterResourceNotFound | TSF MASTER 资源不存在。 |
| InternalError.GroupMasterNuknownError | 部署组操作请求MASTER 操作失败。 |
| InvalidParameterValue.GroupClusterNamespaceNotBound | 部署组的集群未绑定该命名空间。 |
| ResourceNotFound.ContainergroupClusterNotfound | 找不到集群。 |
| ResourceNotFound.GroupApplicationNotExist | 无法获取分组所属应用。 |
| ResourceNotFound.GroupNamespaceNotExist | 无法获取分组所属命名空间。 |
| ResourceNotFound.MicroserviceOffline | 目标微服务已离线[%s]。。 |
| MissingParameter.GroupApplicationNull | 分组所属应用不能为空。 |
| MissingParameter.GroupNamespaceNull | 分组所属命名空间不能为空。 |
| MissingParameter.GroupNameNull | 分组名称不能为空。 |
5. 示例
示例1 创建虚拟机部署组
输入示例
https://tsf.api3.fincloud.tencent.com/?Action=CreateGroup
&ApplicationId=application-xxxxxxx
&GroupName=demo
&NamespaceId=namespace-xxxxxxx
&ClusterId=cluster-xxxxxxx
&<Common Parameters>
输出示例
{
"Response": {
"RequestId": "756cb544-f455-4698-8dfd-feb55d0af366",
"Result": "group-xxxxxxx"
}
}