ModifyHostGroup--日志服务-火山引擎

文档中心

立即注册

导航

日志服务

ModifyHostGroup

最近更新时间：2024.05.29 14:06:41首次发布时间：2022.05.11 11:26:48

调用 ModifyHostGroup 接口修改机器组。

使用说明

此接口的调用频率限制为 20 次/s，超出频率限制会报错 ExceedQPSLimit。
日志服务支持在机器组中添加 IPv4 和 IPv6 服务器。

请求说明

请求方式：PUT
请求地址：https://tls-{Region}.ivolces.com/ModifyHostGroup

请求参数

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

Body

参数	类型	是否必选	示例值	描述
HostGroupId	String	是	`0f********`	机器组 ID。
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：关闭。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

PUT https://tls-{Region}.ivolces.com/ModifyHostGroup HTTP/1.1
Content-Type: application/json
{
    "HostGroupId": "662**********",
    "HostGroupName": "mgn1",
    "HostGroupType": "IP",
    "HostIpList": [
        "192.168.0.1",
        "127.0.0.1"
    ],
    "AutoUpdate": true,
    "UpdateStartTime": "00:00",
    "UpdateEndTime": "02:00",
    "ServiceLogging": true
}

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

错误码

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

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