调用 DescribeHostGroupsV2 接口获取所有机器组信息，不包含机器组心跳信息和绑定的采集规则列表。

支持分页查询，支持按机器组名称和机器组 ID 模糊查询，但只能同时提供其中一项信息进行查询。

注意事项

如果使用自建权限策略，则需要对日志服务资源配置tls:DescribeHostGroups权限操作，详情请参考可授权的操作。

请求说明

请求参数

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

Query

参数	类型	是否必选	示例值	描述
HostGroupId	String	否	6622a14b-770f-4171-a385-3b68486f****	机器组的 ID，支持模糊查询。
HostGroupName	String	否	mgn1	机器组的名称，支持模糊查询。
AutoUpdate	Boolean	否	true	是否开启了自动升级功能。 true：开启 false：关闭。
HostIdentifier	String	否	test	机器组标识。
IamProjectName	String	否	default	访问控制项目名称，用于标识机器组所属的 IAM 项目。默认值为 default。
ServiceLogging	Boolean	否	true	是否已开启服务日志功能。 true：开启 false：关闭。
PageNumber	Integer	否	1	分页查询时的页码。默认为 1，即从第一页数据开始返回。
PageSize	Integer	否	20	单页返回的机器组数量最大值，用于分页查询。默认值为 20。
Hidden	Boolean	否	true	是否隐藏专属资源中的机器组。 true：隐藏； false：不隐藏。

返回参数

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

参数	类型	示例值	描述
HostGroupHostsRulesInfos	Array of HostGroupHostsRulesInfoV2	/	机器组信息列表。
Total	Integer	100	符合条件的机器组总数。

HostGroupHostsRulesInfoV2

参数	类型	示例值	描述
HostGroupInfo	Object of HostGroupInfo	/	机器组信息。

HostGroupInfo

参数	类型	示例值	描述
RuleCount	Integer	1	绑定的采集配置的数量。
AutoUpdate	Boolean	true	机器组服务器中安装的 LogCollector 是否开启自动升级功能。 true：日志服务将会在每天的指定时间段进行升级前检查，若满足升级条件，则自动升级 LogCollector，无需手动操作。 false：（默认）LogCollector 不自动升级，如需使用更高版本的 LogCollector，请参考升级 LogCollector 操作。
CreateTime	String	2021-08-18 13:32:23	机器组创建的时间。
ModifyTime	String	2021-08-18 13:32:23	机器组修改的时间。
HostGroupId	String	0fd**********	机器组的 ID。
HostGroupName	String	testname	机器组的名称。
HostGroupType	String	IP	机器组的类型。 IP：机器 IP。 Label：机器标识。
UpdateEndTime	String	"02:00"	LogCollector 自动升级的结束时间。
HostIdentifier	String	label	机器的标识符。
IamProjectName	String	default	机器组所属的 IAM 项目。
ServiceLogging	Boolean	true	是否开启 Logcollector 服务日志功能。 true：开启。 false：（默认）关闭。
UpdateStartTime	String	"00:00"	LogCollector 自动升级的开始时间。说明仅在 AutoUpdate 为 true 时需要设置。自动升级时间建议设置为业务低峰期，自动升级过程中可能会重启LogCollector，但不会丢失日志。

请求示例

返回示例

错误码

您可访问公共错误码，获取更多错误码信息。