文档中心

日志服务

机器组管理

CreateHostGroup

CreateHostGroup

调用 CreateHostGroup 接口创建机器组。

使用说明

此接口的调用频率限制为 20 次/s，超出频率限制会报错 ExceedQPSLimit。

日志服务支持在机器组中添加 IPv4 和 IPv6 服务器。

创建 IP 类型的机器组之前，请参考获取服务器的 IP 地址获取机器 IP。

创建机器标识类型的机器组时，请参考配置机器标识为机器设置自定义标识。详细说明请参考机器组概述。

请求说明

请求方式：POST

请求地址：https://{tls-endpoint}/CreateHostGroup

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Body

参数	类型	是否必选	示例值	描述
HostGroupName	String	是	mgn1	机器组的名称。命名规则请参考资源命名规则。
HostGroupType	String	是	IP	机器组的类型。包括： IP：机器 IP。此时需通过 HostIpList 参数设置机器 IP 列表。 Label：机器标识。此时需通过 HostIdentifier 参数设置机器标识。
HostIpList	Array of String	否	["192.168.0.1", "127.0.0.1"]	机器 IP 列表。 HostGroupType 为 IP 时必选。
HostIdentifier	String	否	hostlable	机器标识。 HostGroupType 为 Label 时必选。
AutoUpdate	Boolean	否	true	机器组服务器中安装的 LogCollector 是否开启自动升级功能。 true：日志服务将会在每天的指定时间段进行升级前检查，若满足升级条件，则自动升级 LogCollector，无需手动操作。 false：（默认）LogCollector 不自动升级，如需使用更高版本的 LogCollector，请参考升级 LogCollector操作。说明仅 LogCollector V1.0.8 及后续版本支持自动升级。
UpdateStartTime	String	否	"00:00"	LogCollector 自动升级的开始时间。说明仅在 AutoUpdate 为 true 时需要设置。自动升级时间建议设置为业务低峰期，自动升级过程中可能会重启 LogCollector，但不会丢失日志。
UpdateEndTime	String	否	"02:00"	LogCollector 自动升级的结束时间。
ServiceLogging	Boolean	否	true	是否开启 Logcollector 服务日志功能。 true：开启 false：（默认）关闭。
IamProjectName	String	否	default	机器组所属的 IAM 项目名称。未指定此参数时，日志服务会将机器组添加到名为 default的 IAM 项目中。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
HostGroupId	String	bcb**********	机器组的 ID。

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HTTP 状态码	错误码	错误信息	说明
400	InvalidArgument	Invalid argument key %s, value %s, please check argument.	参数不合法。
400	HostGroupQuotaExceed	HostGroup Quota Exceeded	超过机器组限额。
400	HostIpQuotaExceed	Host Ip Quota Exceeded	超过机器 IP 限额。
409	HostGroupAlreadyExist	HostGroup %s already exist	机器组已存在。
500	InternalServerError	We encountered an unexpected server error, please try again later.	服务器内部错误。

最近更新时间：2025.10.14 14:41:12

这个页面对您有帮助吗？

有用

有用

无用

无用