1. 接口描述
接口请求域名： cls.tencentcloudapi.com 。
创建机器组
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateMachineGroup。 |
| Version | 是 | String | 公共参数，本接口取值：2020-10-16。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| GroupName | 是 | String | 机器组名字，不能重复 示例值：testgroup |
| MachineGroupType | 是 | MachineGroupTypeInfo | 创建机器组类型。取值如下： - Type：ip，Values中为ip字符串列表创建机器组 - Type：label，Values中为标签字符串列表创建机器组 |
| Tags.N | 否 | Array of Tag | 标签描述列表，通过指定该参数可以同时绑定标签到相应的机器组。最大支持10个标签键值对，同一个资源只能绑定到同一个标签键下。 |
| AutoUpdate | 否 | Boolean | 是否开启机器组自动更新。默认false 示例值：true |
| UpdateStartTime | 否 | String | 升级开始时间，建议业务低峰期升级LogListener 示例值："12:00:00" |
| UpdateEndTime | 否 | String | 升级结束时间，建议业务低峰期升级LogListener 示例值："13:00:00" |
| ServiceLogging | 否 | Boolean | 是否开启服务日志，用于记录因Loglistener 服务自身产生的log，开启后，会创建内部日志集cls_service_logging和日志主题loglistener_status,loglistener_alarm,loglistener_business，不产生计费。默认false 示例值：true |
| DelayCleanupTime | 否 | Integer | 机器组中机器离线清理时间。单位：天 示例值：30 |
| MetaTags.N | 否 | Array of MetaTagInfo | 机器组元数据信息列表 |
| OSType | 否 | Integer | 系统类型，取值如下： - 0：Linux （默认值） - 1：Windows 示例值：0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| GroupId | String | 机器组ID 示例值：57f5808c-4a55-11eb-b378-0242ac130002 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建机器组
创建机器组
输入示例
POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateMachineGroup
<公共请求参数>
{
"GroupName": "testname",
"MachineGroupType": {
"Type": "ip",
"Values": [
"10.10.1.119"
]
}
}输出示例
{
"Response": {
"GroupId": "57f5808c-4a55-11eb-b378-0242ac130002",
"RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| FailedOperation | 操作失败。 |
| FailedOperation.Timeout | 操作超时 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.MachineGroupConflict | 同名机器组已经存在。 |
| InvalidParameterValue | 参数取值错误。 |
| LimitExceeded | 超过配额限制。 |
| LimitExceeded.MachineGroup | 机器组超过限制。 |
| LimitExceeded.MachineGroupIp | 机器组IP超过限制。 |
| LimitExceeded.MachineGroupIpLabels | 机器组Label超过限制。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| OperationDenied.AccountDestroy | 账户已销毁。 |
| OperationDenied.AccountIsolate | 账户欠费。 |
| OperationDenied.AccountNotExists | 账户不存在。 |
