操作指南

API 文档

创建虚拟机部署组

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

我的收藏

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 公共参数,本接口取值:CreateGroup。
Version String 公共参数,本接口取值:2018-03-26。
Region String 公共参数,详见产品支持的 地域列表
ApplicationId String 部署组所属的应用ID
NamespaceId String 部署组所属命名空间ID
GroupName String 部署组名称
ClusterId String 集群ID
GroupDesc String 部署组描述
GroupResourceType String 部署组资源类型

3. 输出参数

参数名称 类型 描述
Result String groupId, null表示创建失败
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建虚拟机部署组

输入示例

https://tsf.tencentcloudapi.com/?Action=CreateGroup
&ApplicationId=application-xxxxxxx
&GroupName=demo
&NamespaceId=namespace-xxxxxxx
&ClusterId=cluster-xxxxxxx
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "756cb544-f455-4698-8dfd-feb55d0af366",
    "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. 错误码

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

错误码 描述
InvalidParameterValue.GroupNameExist 分组名称已存在,请更换其他名称。
InvalidParameterValue.GroupNameRegxMismatch 部署组名称格式不正确,只能包含小写字母、数字及分隔符("-"),且必须以小写字母开头,数字或小写字母结尾。
ResourceNotFound.ContainergroupClusterNotfound 容器集群不存在。
ResourceNotFound.CvmcaeMasterResourceNotFound TSF MASTER 资源不存在。
ResourceNotFound.MicroserviceOffline 服务离线。
UnauthorizedOperation.NoPrivilege 无访问权限。
目录