# 查询主机组 - ListHostGroup #### 功能介绍 查询主机组信息列表。通过调用该接口可查看当前账号下全部主机组信息，为主机资源管理提供直观的数据支撑。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-lts/lts_api_0003.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-lts/lts_api_0046.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | lts:hostGroup:list | List | accessConfig \* | - | lts:topics:list | - | #### URI POST /v3/{project_id}/lts/host-group-list 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID，可以从调用API处获取，也可以从控制台获取。获取方式请参见：[获取项目ID](https://support.huaweicloud.com/api-lts/lts_api_0006.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 从IAM服务获取的用户Token，获取方式请参见：[获取用户Token](https://support.huaweicloud.com/api-lts/lts_api_0004.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | Content-Type | 是 | String | **参数解释：** 用于定义消息体的格式，该字段填为：application/json;charset=utf8。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | host_group_id_list | 否 | Array of strings | **参数解释：** 主机组ID列表，通过主机组ID列表对主机组进行批量过滤。 **约束限制：** 不涉及。 | | filter | 是 | [GetHostGroupListFilter] object | **参数解释：** 查询主机组过滤参数。 **约束限制：** 不涉及。 | 表4GetHostGroupListFilter | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | host_group_type | 否 | String | **参数解释：** 主机类型。支持两种类型，分别为windows类型和linux类型。 **约束限制：** 不涉及。 **取值范围：** - windows - linux **默认取值：** 不涉及。 | | host_group_name_list | 否 | Array of strings | **参数解释：** 主机组名称列表。 **约束限制：** 不涉及。 | | host_name_list | 否 | Array of strings | **参数解释：** 主机名称列表。 **约束限制：** 不涉及。 | | host_group_tag | 否 | [GetHostGroupListTag] object | **参数解释：** 主机组标签信息。 **约束限制：** 最多支持20个标签。 | 表5GetHostGroupListTag | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | tag_type | 否 | String | **参数解释：** 标签过滤的逻辑类型，用于多个标签条件来筛选资源。 **约束限制：** 不涉及。 **取值范围：** - AND：标签过滤的逻辑为与，资源必须包括所有标签。 - OR：标签过滤的逻辑为或，资源包括至少一个标签。 **默认取值：** 不涉及。 | | tag_list | 否 | Array of [HostGroupTag] objects | **参数解释：** 主机组标签。以键值对（key-value）的形式表示，其中key表示标签键，标签键不能重复，value表示标签值。例如：{"env": "test"}。 **约束限制：** 不涉及。 | 表6HostGroupTag | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | key | 否 | String | **参数解释：** 标签键。 **约束限制：** - 标签键名称不可重复。 - 标签是以键值对（key-value）的形式表示，key和value为一一对应关系。 **取值范围：** 标签键可以包含任意语种的字母、数字和空格，以及_.:=+-@字符，但首尾不能包含空格，且不能以_sys_开头。 标签键长度不能超过128个字符。 **默认取值：** 不涉及。 | | value | 否 | String | **参数解释：** 标签值。 **约束限制：** - 标签是以键值对（key-value）的形式表示，key和value为一一对应关系。 - 标签值可以包含任意语种的字母、数字和空格，以及_.:=+-@字符。 - 标签值长度不能超过255个字符。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 响应参数 **状态码：200** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | result | Array of [GetHostGroupInfo] objects | **参数解释：** 主机组信息列表。 | | total | Long | **参数解释：** 主机组信息总数量。 **取值范围：** 不涉及。 | 表8GetHostGroupInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | host_group_id | String | **参数解释：** 主机组ID。 **取值范围：** 不涉及。 | | host_group_name | String | **参数解释：** 主机组名称。 **取值范围：** 不涉及。 | | host_group_type | String | **参数解释：** 主机类型。 **取值范围：** - linux - windows | | host_id_list | Array of strings | **参数解释：** 主机ID列表。 | | host_group_tag | Array of [HostGroupTagResBody] objects | **参数解释：** 主机组标签信息。 | | create_time | Long | **参数解释：** 主机组创建时间。 **取值范围：** 不涉及。 | | update_time | Long | **参数解释：** 主机组更新时间。 **取值范围：** 不涉及。 | | agent_access_type | String | **参数解释：** 主机组类型。分别为IP、LABEL类型。 **取值范围：** - IP。 - LABEL。 | | labels | Array of strings | **参数解释：** 主机组自定义标识。 **取值范围：** 不涉及。 | 表9HostGroupTagResBody | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释：** 标签键。 **取值范围：** 不涉及。 | | value | String | **参数解释：** 标签值。 **取值范围：** 不涉及。 | **状态码：400** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码，请参见：[错误码](https://support.huaweicloud.com/api-lts/ErrorCode.html)。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 调用失败响应信息描述。 **取值范围：** 不涉及。 | **状态码：500** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码，请参见：[错误码](https://support.huaweicloud.com/api-lts/ErrorCode.html)。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 调用失败响应信息描述。 **取值范围：** 不涉及。 | #### 请求示例 查询主机组信息列表，根据传入的Body体进行过滤。若是body体中无过滤参数，则查询全量数据。 ``` POST https://{endpoint}/v3/{project_id}/lts/host-group-list { "host_group_id_list" : [ "bca6d903-3528-42a8-91f4-586722cxxxxx" ], "filter" : { "host_group_type" : "linux", "host_group_name_list" : [ "wjyTxxx", "xxxest" ], "host_name_list" : [ "ecs-apmtexxx删" ], "host_group_tag" : { "tag_type" : "AND", "tag_list" : [ { "key" : "xxx", "value" : "xxx" } ] } } } ``` #### 响应示例 **状态码：200** 查询主机组列表请求响应成功。 ``` { "result" : [ { "host_group_id" : "598c77aa-c69b-42f0-8cb8-xxxx5b38", "host_group_name" : "devspoxxxou1", "host_group_type" : "linux", "host_id_list" : [ "dc1dab7e-b04xxxx", "xxxxx" ], "host_group_tag" : [ { "key" : "xxx", "value" : "xxx" }, { "key" : "xxx", "value" : "xxx" } ], "create_time" : 1785918922315, "update_time" : 1785918922315 } ], "total" : 1 } ``` **状态码：400** 非法请求，建议根据error_msg直接修改该请求。 ``` { "error_code" : "LTS.1807", "error_msg" : "Invalid host group id" } ``` **状态码：500** 表明服务端能被请求访问到，但是服务内部出错。 ``` { "error_code" : "LTS.0010", "error_msg" : "Internal Server Error" } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 查询主机组信息列表，根据传入的Body体进行过滤。若是body体中无过滤参数，则查询全量数据。 ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.lts.v2.region.LtsRegion; import com.huaweicloud.sdk.lts.v2.*; import com.huaweicloud.sdk.lts.v2.model.*; import java.util.List; import java.util.ArrayList; public class ListHostGroupSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); LtsClient client = LtsClient.newBuilder() .withCredential(auth) .withRegion(LtsRegion.valueOf("")) .build(); ListHostGroupRequest request = new ListHostGroupRequest(); GetHostGroupListRequestBody body = new GetHostGroupListRequestBody(); List listHostGroupTagTagList = new ArrayList<>(); listHostGroupTagTagList.add( new HostGroupTag() .withKey("xxx") .withValue("xxx") ); GetHostGroupListTag hostGroupTagFilter = new GetHostGroupListTag(); hostGroupTagFilter.withTagType(GetHostGroupListTag.TagTypeEnum.fromValue("AND")) .withTagList(listHostGroupTagTagList); List listFilterHostNameList = new ArrayList<>(); listFilterHostNameList.add("ecs-apmtexxx删"); List listFilterHostGroupNameList = new ArrayList<>(); listFilterHostGroupNameList.add("wjyTxxx"); listFilterHostGroupNameList.add("xxxest"); GetHostGroupListFilter filterbody = new GetHostGroupListFilter(); filterbody.withHostGroupType(GetHostGroupListFilter.HostGroupTypeEnum.fromValue("linux")) .withHostGroupNameList(listFilterHostGroupNameList) .withHostNameList(listFilterHostNameList) .withHostGroupTag(hostGroupTagFilter); List listbodyHostGroupIdList = new ArrayList<>(); listbodyHostGroupIdList.add("bca6d903-3528-42a8-91f4-586722cxxxxx"); body.withFilter(filterbody); body.withHostGroupIdList(listbodyHostGroupIdList); request.withBody(body); try { ListHostGroupResponse response = client.listHostGroup(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` - [Python] 查询主机组信息列表，根据传入的Body体进行过滤。若是body体中无过滤参数，则查询全量数据。 ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdklts.v2.region.lts_region import LtsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdklts.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = LtsClient.new_builder() \ .with_credentials(credentials) \ .with_region(LtsRegion.value_of("")) \ .build() try: request = ListHostGroupRequest() listTagListHostGroupTag = [ HostGroupTag( key="xxx", value="xxx" ) ] hostGroupTagFilter = GetHostGroupListTag( tag_type="AND", tag_list=listTagListHostGroupTag ) listHostNameListFilter = [ "ecs-apmtexxx删" ] listHostGroupNameListFilter = [ "wjyTxxx", "xxxest" ] filterbody = GetHostGroupListFilter( host_group_type="linux", host_group_name_list=listHostGroupNameListFilter, host_name_list=listHostNameListFilter, host_group_tag=hostGroupTagFilter ) listHostGroupIdListbody = [ "bca6d903-3528-42a8-91f4-586722cxxxxx" ] request.body = GetHostGroupListRequestBody( filter=filterbody, host_group_id_list=listHostGroupIdListbody ) response = client.list_host_group(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] 查询主机组信息列表，根据传入的Body体进行过滤。若是body体中无过滤参数，则查询全量数据。 ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" lts "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := lts.LtsClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := lts.NewLtsClient(hcClient) request := &model.ListHostGroupRequest{} keyTagList:= "xxx" valueTagList:= "xxx" var listTagListHostGroupTag = []model.HostGroupTag{ { Key: &keyTagList, Value: &valueTagList, }, } tagTypeHostGroupTag:= model.GetGetHostGroupListTagTagTypeEnum().AND hostGroupTagFilter := &model.GetHostGroupListTag{ TagType: &tagTypeHostGroupTag, TagList: &listTagListHostGroupTag, } var listHostNameListFilter = []string{ "ecs-apmtexxx删", } var listHostGroupNameListFilter = []string{ "wjyTxxx", "xxxest", } hostGroupTypeFilter:= model.GetGetHostGroupListFilterHostGroupTypeEnum().LINUX filterbody := &model.GetHostGroupListFilter{ HostGroupType: &hostGroupTypeFilter, HostGroupNameList: &listHostGroupNameListFilter, HostNameList: &listHostNameListFilter, HostGroupTag: hostGroupTagFilter, } var listHostGroupIdListbody = []string{ "bca6d903-3528-42a8-91f4-586722cxxxxx", } request.Body = &model.GetHostGroupListRequestBody{ Filter: filterbody, HostGroupIdList: &listHostGroupIdListbody, } response, err := client.ListHostGroup(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/LTS/sdk?api=ListHostGroup)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询主机组列表请求响应成功。 | | 400 | 非法请求，建议根据error_msg直接修改该请求。 | | 500 | 表明服务端能被请求访问到，但是服务内部出错。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-lts/ErrorCode.html)。