Call the CreateHostGroup interface to create a host group.

Usage notes

The call frequency limit is 20 times/s, and exceeding the frequency limit will report an error ExceedQPSLimit.

Torch Log Service supports adding IPv4 and IPv6 servers in the host group.

Before creating an IP type host group, please refer to Obtain the IP address of the server to get the host IP.

When creating a host identifier type host group, please refer to Configure host identifier to set custom identifiers for the host. For detailed instructions, please refer to Host Group Overview.

Request syntax

Request Method: POST

Request URL: https://tls-{Region}.ivolces.com/CreateHostGroup

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
HostGroupName	String	True	mgn1	The name of the host group. Please refer to the Resource Naming limit for the naming rules.
HostGroupType	String	True	IP	The types of the host groups. Including: IP: The IP address of the host. At this point, you need to set the IP address list through the HostIpList parameter. Label: The custom identifier. At this point, you need to set the custom identifier through the HostIdentifier parameter.
HostIpList	Array of String	False	["192.168.0.1", "127.0.0.1"]	The list of the host IP addresses. Required when HostGroupType is IP.
HostIdentifier	String	False	hostlable	The custom identifier. Required when HostGroupType is Label.
AutoUpdate	Boolean	False	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 automatic upgrade. tip Only needs to be set when AutoUpdate is true. The automatic upgrade time is recommended to be set during the off-peak period of the business. LogCollector may be restarted during the automatic upgrade process, but logs will not be lost.
UpdateEndTime	String	False	"02:00"	The end time of the automatic upgrade for LogCollector.
ServiceLogging	Boolean	False	true	Should the Logcollector service log function be enabled? true: Enable false: (Default) Disable.
IamProjectName	String	False	default	The name of the IAM project to which the host group belongs. If this parameter is not specified, Torch Log Service will add the host group to an IAM project named default.

Responses

The table below only lists the return parameters specific to this interface. For more information, please refer to the Response message.

Name	Type	Example	Description
HostGroupId	String	bcb**********	The ID of the host group.

Sample Request

Sample Response

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.
400	HostGroupQuotaExceed	HostGroup Quota Exceeded	The host group limit has been exceeded.
400	HostIpQuotaExceed	Host Ip Quota Exceeded	Exceeded host IP limit.
409	HostGroupAlreadyExist	HostGroup %s already exist	The host group already exists.
500	InternalServerError	We encountered an unexpected server error, please try again later.	Internal server error.

Torch Log Service