You need to enable JavaScript to run this app.
Torch Log Service

Torch Log Service

Copy page
Download PDF
Host group management API
ModifyHostGroupsAutoUpdate
Copy page
Download PDF
ModifyHostGroupsAutoUpdate
Call the ModifyHostGroupsAutoUpdate interface to batch modify the LogCollector automatic upgrade configuration of the host group.​
Usage notes​
  • This interface is used for bulk modification of the LogCollector auto-upgrade configuration of the host group, such as whether to enable auto-upgrade, start and end time of the upgrade.​
Request syntax​
  • Request Method: PUT​
  • Request URL: https://{tls-endpoint}/ModifyHostGroupsAutoUpdate​
Request parameters​
The table below only lists the request parameters specific to this interface and some common parameters. For more information, please see Common parameters.​
Body​
​
Name​
Type​
Required​
Example​
Description​
HostGroupIds​
Array of String​
True​
["4be5e4e3-2a3a-48ba-80a8-4446d7d5****", "c701baeb-559d-46bb-a79d-0faa7b16****"]​
The list of the host groups.​
AutoUpdate​
Boolean​
True​
true​
Whether the LogCollector installed on the host group servers has the auto-upgrade feature enabled.​
  • true: Torch Log Service will check for upgrades during a designated time each day. If the conditions for an upgrade are met, LogCollector will automatically upgrade itself, eliminating the need for manual operation.​
  • false: (default) LogCollector does not auto-upgrade. If you need to use a higher version of LogCollector, please refer to Upgrade LogCollector for operation.​
tip​
Only LogCollector V1.0.8 and subsequent versions support automatic upgrades.​
UpdateStartTime​
String​
False​
"00:00"​
The start time of LogCollector's automatic upgrade.​
tip​
  • Only needs to be set when AutoUpdate is true.​
  • The auto-upgrade time is recommended to be set during off-peak business hours. LogCollector may restart during the auto-upgrade process, but no logs will be lost.​
UpdateEndTime​
String​
False​
"02:00"​
The end time of the automatic upgrade for LogCollector.​
​
Responses​
There are no unique return parameters for this interface. For more information, please refer to the Response message.​
Sample Request​
​
PUT https://{tls-endpoint}/ModifyHostGroupsAutoUpdate HTTP/1.1​
Content-Type: application/json​
{​
"HostGroupIds": [​
"4be5e4e3-2a3a-48ba-80a8-4446d7d5****",​
"c701baeb-559d-46bb-a79d-0faa7b16****"​
],​
"AutoUpdate": true,​
"UpdateStartTime": "00:00",​
"UpdateEndTime": "02:00"​
}​
​
Sample Response​
​
HTTP/1.1 200 OK​
Content-Type: application/json; charset=utf-8​
​
Error code​
The following table lists the error codes related to the interface and business logic. For common error codes, please refer to the Common error codes.​
​
HTTP status code​
Error code​
Error message​
Description​
400​
InvalidArgument​
Invalid argument key %s, value %s, please check argument.​
The parameter is invalid.​
500​
InternalServerError​
We encountered an unexpected server error, please try again later.​
Internal server error.​
​
​
​
Last updated: 2025.10.28 18:41:59