Querying Host Groups
Function
Query the host group list.
Calling Method
For details, see Calling APIs.
URI
POST /v3/{project_id}/lts/host-group-list
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain a project ID, see Obtaining the Project ID, Account ID, Log Group ID, and Log Stream ID. Minimum: 1 Maximum: 64 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token obtained from IAM. For details about how to obtain a user token, see Obtaining a User Token. Minimum: 1 Maximum: 10000 |
Content-Type |
Yes |
String |
Set this parameter to application/json;charset=UTF-8. Minimum: 30 Maximum: 30 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
host_group_id_list |
No |
Array of strings |
List of host group IDs. Minimum: 36 Maximum: 36 |
filter |
Yes |
GetHostGroupListFilter object |
Host group filters. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
host_group_type |
No |
String |
Host group type. windows and linux. |
host_group_name_list |
No |
Array of strings |
List of host group names. Minimum: 1 Maximum: 64 |
host_name_list |
No |
Array of strings |
Host name list. Minimum: 1 Maximum: 128 |
host_group_tag |
No |
GetHostGroupListTag object |
Host group tags. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
tag_type |
No |
String |
Tag type. Tag filtering logic: AND or OR. |
tag_list |
No |
Array of HostGroupTag objects |
Host group tags. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
result |
Array of GetHostGroupInfo objects |
Host group list. |
total |
Long |
Total number of host groups. Minimum: 0 Maximum: 1000 |
Parameter |
Type |
Description |
---|---|---|
host_group_id |
String |
Host group ID. Minimum: 36 Maximum: 36 |
host_group_name |
String |
Host group name. Minimum: 1 Maximum: 64 |
host_group_type |
String |
Host group type. Linux and Windows. |
host_id_list |
Array of strings |
Host ID list. Minimum: 36 Maximum: 36 |
host_group_tag |
Array of HostGroupTagResBody objects |
Tag information. |
create_time |
Long |
Creation time. Minimum: 0 Maximum: 9999999999999 |
update_time |
Long |
Update time. Minimum: 0 Maximum: 9999999999999 |
Parameter |
Type |
Description |
---|---|---|
key |
String |
Tag key. Minimum: 1 Maximum: 36 |
value |
String |
Tag value. Minimum: 1 Maximum: 36 |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. Minimum: 8 Maximum: 8 |
error_msg |
String |
Error description. Minimum: 1 Maximum: 1000 |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. Minimum: 8 Maximum: 8 |
error_msg |
String |
Error description. Minimum: 1 Maximum: 1000 |
Example Requests
Host groups are sorted by filters specified in the request body. If no filters are configured in the body, all host groups are queried.
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 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.
Host groups are sorted by filters specified in the request body. If no filters are configured in the body, all host groups are queried.
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()); } } } |
Host groups are sorted by filters specified in the request body. If no filters are configured in the body, all host groups are queried.
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) |
Host groups are sorted by filters specified in the request body. If no filters are configured in the body, all host groups are queried.
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 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