1. 接口描述
接口请求域名: cls.api3.fincloud.tencent.cn。
创建机器组
默认接口请求频率限制:20次/秒。
接口更新时间:2025-01-17 02:55:38。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:CreateMachineGroup |
| Version | 是 | 否 | String | 公共参数,本接口取值:2020-10-16 |
| Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| GroupName | 是 | 否 | String | 机器组名字,不能重复 示例值: group_name |
| MachineGroupType | 是 | 否 | MachineGroupTypeInfo | 创建机器组类型。取值如下: Type:ip,Values中为ip字符串列表创建机器组 Type:label,Values中为标签字符串列表创建机器组 示例值:查看 |
| Tags | 否 | 否 | Array of Tag | 标签描述列表,通过指定该参数可以同时绑定标签到相应的机器组。最大支持10个标签键值对,同一个资源只能绑定到同一个标签键下。 示例值:查看 |
| AutoUpdate | 否 | 否 | Bool | 是否开启机器组自动更新。true表示开启机器组自动更新,false表示关闭机器组自动更新。是否开启机器组自动更新。默认false 示例值: true |
| UpdateStartTime | 否 | 否 | String | 升级开始时间,建议业务低峰期升级LogListener 示例值: "12:00:00" |
| UpdateEndTime | 否 | 否 | String | 升级结束时间,建议业务低峰期升级LogListener 示例值: "13:00:00" |
| ServiceLogging | 否 | 否 | Bool | 是否开启服务日志,用于记录因Loglistener 服务自身产生的log,开启后,会创建内部日志集cls_service_logging和日志主题loglistener_status,loglistener_alarm,loglistener_business,不产生计费。默认false 示例值: true |
| Flag | 否 | 否 | String | TKE标志位,默认值为空字符串。空字符串表示日志不是来自于TKE,label_k8s表示日志来自于TKE。 示例值: label_k8s |
| DelayCleanupTime | 否 | 否 | Int64 | 机器组中机器离线清理时间。单位:天 示例值: 30 |
| MetaTags | 否 | 否 | Array of MetaTagInfo | 机器组元数据信息列表 示例值:查看 |
| OSType | 否 | 否 | Uint64 | 系统类型,取值如下: 0:Linux (默认值) 1:Windows 示例值: 0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| GroupId | String | 机器组ID 示例值: 57f5808c-4a55-11eb-b378-0242ac130002 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |
| InternalError | 内部错误。 |
| LimitExceeded | 超过配额限制。 |
| FailedOperation | 操作失败。 |
| AuthFailure | CAM签名/鉴权错误。 |
| OperationDenied | 操作被拒绝。 |
| LimitExceeded.MachineGroup | 机器组超过限制。 |
| InvalidParameter.MachineGroupConflict | 同名机器组已经存在。 |
| LimitExceeded.MachineGroupIp | 机器组IP超过限制。 |
| LimitExceeded.MachineGroupLabels | 机器组Label超过限制。 |
| OperationDenied.AccountIsolate | 账户欠费。 |
| OperationDenied.AccountDestroy | 账户已销毁。 |
| OperationDenied.AccountNotExists | 账户不存在。 |