Call the DescribeHostGroupV2 API to obtain host group information, excluding host group heartbeat details and the list of associated collection rules.

Precautions

If you use a self-built permission policy, you need to configure the tls:DescribeHostGroup permission operation for the log service resource. For more information, see Authorized operations.

Request instructions

Request method: GET

Request URL: https://{tls-endpoint}/DescribeHostGroupV2

Request parameters

The following table lists only the request parameters unique to this API and some common parameters. For more information, see Common Parameters.

Query

Parameters	Type	Required	Example value	Description
HostGroupId	String	Yes	"c7e0e442-19bf-4fb3-b547-5992fb8b****"	Host group ID.

Response parameters

The following table only lists response parameters unique to this API. For more information, see Response Structure.

Parameters	Type	Example value	Description
HostGroupHostsRulesInfo	Object of HostGroupHostsRulesInfoV2	/	Host group information list.

HostGroupHostsRulesInfoV2

Parameters	Type	Example value	Description
HostGroupInfo	Object of HostGroupInfo	/	Host group information.

HostGroupInfo

Parameters	Type	Example value	Description
HostCount	Integer	2	Number of machines.
RuleCount	Integer	1	The number of bound collection configurations.
AutoUpdate	Boolean	true	LogCollector installed on the host group server has auto-upgrade function. You can choose whether to enable it. true: TLS checks for upgrades during the specified time period each day. If the upgrade conditions are met, LogCollector is updated automatically without manual intervention. false: (Default) LogCollector does not upgrade automatically. To use a higher version, refer to Upgrade LogCollector.
CreateTime	String	2021-08-18 13:32:23	The creation time of the host group.
ModifyTime	String	2021-08-18 13:32:23	Time when the host group was modified.
HostGroupId	String	0fd**********	ID of the host group.
HostGroupName	String	testname	Name of the host group.
HostGroupType	String	IP	The type of host group. IP: Machine IP. Label: Host identification.
UpdateEndTime	String	"02:00"	LogCollector automatic upgrade end time.
HostIdentifier	String	label	Identifier of the machine.
IamProjectName	String	default	The IAM project to which the host group belongs.
ServiceLogging	Boolean	true	Enable Logcollector service log feature. true: Enabled. false: (default) Disabled.
UpdateStartTime	String	"00:00"	LogCollector automatic upgrade start time. tip Only required when AutoUpdate is set to true. For automatic upgrades, we recommend setting the upgrade time during off-peak business hours. LogCollector may restart during the upgrade, but no logs will be lost.
AgentLatestVersion	String	"2.3.4"	The latest version number of LogCollector released by TLS.
NormalHeartbeatStatusCount	Integer	1	Number of machines with normal heartbeat.
AbnormalHeartbeatStatusCount	Integer	1	Number of machines with heartbeat exceptions.

Sample request

Sample response

Error Code

You can visit Public Error Codes for more details on error codes.

Torch Log Service