Querying Host Groups
Function
This API is used to query the host group list, including details about all host groups in the account. It provides data support for host resource management.
Calling Method
For details, see Calling APIs.
URI
POST /v3/{project_id}/lts/host-group-list
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition Project ID. It can be obtained by calling an API or from the console. For details, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition User token obtained from IAM. For details about how to obtain it, see Obtaining a User Token. Constraints: N/A Range N/A Default Value N/A |
Content-Type |
Yes |
String |
Definition Message body format. Set this parameter to application/json;charset=utf8. Constraints N/A Range N/A Default Value N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
host_group_id_list |
No |
Array of strings |
Definition Host group ID list. Host groups can be filtered by host group ID. Constraints N/A |
filter |
Yes |
GetHostGroupListFilter object |
Definition Filtering parameters for querying host groups. Constraints N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
host_group_type |
No |
String |
Definition Host group type. Two types are supported: Windows and Linux. Constraints N/A Range
Default Value N/A |
host_group_name_list |
No |
Array of strings |
Definition Host group name list. Constraints N/A |
host_name_list |
No |
Array of strings |
Definition Host name list. Constraints N/A |
host_group_tag |
No |
GetHostGroupListTag object |
Definition Host group tags. Constraints You can add up to 20 tags. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
tag_type |
No |
String |
Definition Logical type of tag filtering. It is used to filter resources based on multiple tag conditions. Constraints N/A Range
Default Value N/A |
tag_list |
No |
Array of HostGroupTag objects |
Definition Host group tags. Tags are key-value pairs. The key is the unique identifier for the tag, and the value is its corresponding data. Example: {"env": "test"} Constraints N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
key |
No |
String |
Definition Tag key. Constraints
Range A tag key can contain letters, digits, spaces, and special characters (_.:=+-@), but cannot start or end with a space or start with sys. A tag key can contain up to 128 characters. Default Value N/A |
value |
No |
String |
Definition Tag value. Constraints A tag is a key-value pair. Each key is paired with its corresponding value. Range
Default Value N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
result |
Array of GetHostGroupInfo objects |
Definition Host group information list. |
total |
Long |
Definition Total number of host groups. Range N/A |
Parameter |
Type |
Description |
---|---|---|
host_group_id |
String |
Definition Host group ID. Range N/A |
host_group_name |
String |
Definition Host group name. Range N/A |
host_group_type |
String |
Definition Host group type. Range
|
host_id_list |
Array of strings |
Definition Host ID list. |
host_group_tag |
Array of HostGroupTagResBody objects |
Definition Host group tags. |
create_time |
Long |
Definition Time when the host group was created. Range N/A |
update_time |
Long |
Definition Time when the host group was updated. Range N/A |
agent_access_type |
String |
Definition Host group type. The value can be IP or LABEL. Range
|
labels |
Array of strings |
Definition Custom identifier of the host group. |
Parameter |
Type |
Description |
---|---|---|
key |
String |
Definition Tag key. Range N/A |
value |
String |
Definition Tag value. Range N/A |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Definition Error code. For details, see Error Codes. Range N/A |
error_msg |
String |
Definition Error message. Range N/A |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Definition Error code. For details, see Error Codes. Range N/A |
error_msg |
String |
Definition Error message. Range N/A |
Example Requests
Query host groups and filter them based on the request body. If no filters are provided in the body, all host groups are returned.
POST https://{endpoint}/v3/{project_id}/lts/host-group-list { "host_group_id_list" : [ "bca6d903-3528-42a8-91f4-586722cxxxxx" ], "filter" : { "host_group_type" : "lixxx", "host_group_name_list" : [ "wjyTxxx", "xxxest" ], "host_name_list" : [ "ecs-apmtexxxdeletion" ], "host_group_tag" : { "tag_type" : "AND", "tag_list" : [ { "key" : "xxx", "value" : "xxx" } ] } } }
Example Responses
Status code: 200
The host group list query is successful.
{ "result" : [ { "host_group_id" : "598c77aa-c69b-42f0-8cb8-xxxx5b38", "host_group_name" : "devspoxxxou1", "host_group_type" : "lxxux", "host_id_list" : [ "dc1dab7e-b04xxxx", "xxxxx" ], "host_group_tag" : [ { "key" : "xxx", "value" : "xxx" }, { "key" : "xxx", "value" : "xxx" } ], "create_time" : 1635459410332, "update_time" : 163560332 } ], "total" : 1 }
Status code: 400
Invalid request. Modify the request based on the description in error_msg before a retry.
{ "error_code" : "LTS.1807", "error_msg" : "Invalid host group id" }
Status code: 500
The server has received the request but encountered an internal error.
{ "error_code" : "LTS.0010", "error_msg" : "Internal Server Error" }
SDK Sample Code
The SDK sample code is as follows.
Query host groups and filter them based on the request body. If no filters are provided in the body, all host groups are returned.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 |
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("<YOUR REGION>")) .build(); ListHostGroupRequest request = new ListHostGroupRequest(); GetHostGroupListRequestBody body = new GetHostGroupListRequestBody(); List<HostGroupTag> listHostGroupTagTagList = new ArrayList<>(); listHostGroupTagTagList.add( new HostGroupTag() .withKey("xxx") .withValue("xxx") ); GetHostGroupListTag hostGroupTagFilter = new GetHostGroupListTag(); hostGroupTagFilter.withTagType(GetHostGroupListTag.TagTypeEnum.fromValue("AND")) .withTagList(listHostGroupTagTagList); List<String> listFilterHostNameList = new ArrayList<>(); listFilterHostNameList.add("ecs-apmtexxxdeletion"); List<String> listFilterHostGroupNameList = new ArrayList<>(); listFilterHostGroupNameList.add("wjyTxxx"); listFilterHostGroupNameList.add("xxxest"); GetHostGroupListFilter filterbody = new GetHostGroupListFilter(); filterbody.withHostGroupType(GetHostGroupListFilter.HostGroupTypeEnum.fromValue("lixxx")) .withHostGroupNameList(listFilterHostGroupNameList) .withHostNameList(listFilterHostNameList) .withHostGroupTag(hostGroupTagFilter); List<String> 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()); } } } |
Query host groups and filter them based on the request body. If no filters are provided in the body, all host groups are returned.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 |
# 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("<YOUR REGION>")) \ .build() try: request = ListHostGroupRequest() listTagListHostGroupTag = [ HostGroupTag( key="xxx", value="xxx" ) ] hostGroupTagFilter = GetHostGroupListTag( tag_type="AND", tag_list=listTagListHostGroupTag ) listHostNameListFilter = [ "ecs-apmtexxxdeletion" ] listHostGroupNameListFilter = [ "wjyTxxx", "xxxest" ] filterbody = GetHostGroupListFilter( host_group_type="lixxx", 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) |
Query host groups and filter them based on the request body. If no filters are provided in the body, all host groups are returned.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 |
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 := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := lts.NewLtsClient( lts.LtsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) 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-apmtexxxdeletion", } var listHostGroupNameListFilter = []string{ "wjyTxxx", "xxxest", } hostGroupTypeFilter:= model.GetGetHostGroupListFilterHostGroupTypeEnum().LIXXX 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) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
The host group list query is successful. |
400 |
Invalid request. Modify the request based on the description in error_msg before a retry. |
500 |
The server has received the request but encountered an internal error. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot