查询主机组
功能介绍
查询主机组列表
调用方法
请参见如何调用API。
URI
POST /v3/{project_id}/lts/host-group-list
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID 最小长度:1 最大长度:64 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token,获取方式请参见:获取用户Token 最小长度:1 最大长度:10000 |
Content-Type |
是 |
String |
该字段填为:application/json;charset=UTF-8。 最小长度:30 最大长度:30 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
host_group_id_list |
否 |
Array of strings |
主机组ID 最小长度:36 最大长度:36 |
filter |
是 |
GetHostGroupListFilter object |
主机组过滤参数 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
host_group_type |
否 |
String |
主机组类型。windows:windows类型,linux:linux类型 |
host_group_name_list |
否 |
Array of strings |
主机组名称列表。 最小长度:1 最大长度:64 |
host_name_list |
否 |
Array of strings |
主机名称列表。 最小长度:1 最大长度:128 |
host_group_tag |
否 |
GetHostGroupListTag object |
主机组标签信息 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
tag_type |
否 |
String |
标签类型。AND:标签过滤的逻辑为与,OR:标签过滤的逻辑为或 |
tag_list |
否 |
Array of HostGroupTag objects |
主机组标签 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
result |
Array of GetHostGroupInfo objects |
主机组列表 |
total |
Long |
主机组信息总数量 最小值:0 最大值:1000 |
参数 |
参数类型 |
描述 |
---|---|---|
host_group_id |
String |
主机组ID 最小长度:36 最大长度:36 |
host_group_name |
String |
主机组名称 最小长度:1 最大长度:64 |
host_group_type |
String |
主机组类型。linux:linux类型,windows:windows类型 |
host_id_list |
Array of strings |
主机ID列表 最小长度:36 最大长度:36 |
host_group_tag |
Array of HostGroupTagResBody objects |
标签信息. |
create_time |
Long |
创建时间 最小值:0 最大值:9999999999999 |
update_time |
Long |
更新时间 最小值:0 最大值:9999999999999 |
参数 |
参数类型 |
描述 |
---|---|---|
key |
String |
标签Key 最小长度:1 最大长度:36 |
value |
String |
标签Value 最小长度:1 最大长度:36 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 最小长度:8 最大长度:8 |
error_msg |
String |
错误描述 最小长度:1 最大长度:1000 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 最小长度:8 最大长度:8 |
error_msg |
String |
错误描述 最小长度:1 最大长度:1000 |
请求示例
查询主机组信息,根据传入的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" : "lixxx", "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" : "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 }
状态码: 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代码示例如下。
查询主机组信息,根据传入的Body体进行过滤。若是body体中无过滤参数,则查询全量数据。
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-apmtexxx删"); 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()); } } } |
查询主机组信息,根据传入的Body体进行过滤。若是body体中无过滤参数,则查询全量数据。
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-apmtexxx删" ] 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) |
查询主机组信息,根据传入的Body体进行过滤。若是body体中无过滤参数,则查询全量数据。
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-apmtexxx删", } 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) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
查询主机组列表请求响应成功 |
400 |
非法请求 建议根据error_msg直接修改该请求。 |
500 |
表明服务端能被请求访问到,但是服务内部出错。 |
错误码
请参见错误码。