查询主机信息
功能介绍
查询主机列表
调用方法
请参见如何调用API。
URI
POST /v3/{project_id}/lts/host-list
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token,获取方式请参见:获取用户Token |
Content-Type |
是 |
String |
该字段填为:application/json;charset=utf8。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
host_id_list |
否 |
Array of strings |
主机ID列表。可以根据主机ID列表进行批量过滤 |
filter |
是 |
GetHostListFilter object |
查询主机信息过滤参数 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
host_name_list |
否 |
Array of strings |
主机名称列表。可以根据主机名称列表,进行批量过滤 |
host_ip_list |
否 |
Array of strings |
主机IP列表。可以根据主机IP列表,进行批量过滤。 |
host_status |
否 |
String |
主机状态。可以根据主机状态进行过滤。 uninstall:未安装 running:运行 offline:离线 error:异常 plugin error:插件错误 installing:安装中 install-fail:安装失败 upgrading:升级中 upgrading-transient:升级中 upgrade failed:升级失败 upgrade-fail:升级失败 uninstalling:卸载中 uninstalling-transient:卸载中 authentication error:鉴权失败 |
host_version |
否 |
String |
主机版本。可以根据主机版本进行过滤。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
result |
Array of GetHostListInfo objects |
主机列表 |
total |
Long |
主机信息总数量 |
参数 |
参数类型 |
描述 |
---|---|---|
host_id |
String |
主机ID |
host_ip |
String |
主机IP |
host_name |
String |
主机名称 |
host_status |
String |
主机状态。 uninstall:未安装 running:运行 offline:离线 error:异常 plugin error:插件错误 installing:安装中 install-fail:安装失败 upgrading:升级中 upgrading-transient:升级中 upgrade failed:升级失败 upgrade-fail:升级失败 uninstalling:卸载中 uninstalling-transient:卸载中 authentication error:鉴权失败 |
host_type |
String |
主机类型。linux:linux类型,windows:windows类型 |
host_version |
String |
主机版本 |
update_time |
Long |
更新时间 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
查询主机信息,根据传入的Body体进行过滤。若是body体中无过滤参数,则查询全量数据。
POST https://{endpoint}/v3/{project_id}/lts/host-list { "host_id_list" : [ "713a9f81-574b-45aa-92df-24c4caxxxxxx", "c7085aa9-2142-4ada-9f78-bf81ffxxxxxx" ], "filter" : { "host_name_list" : [ "ecs-xxxx", "10.66.16xxx" ], "host_ip_list" : [ "192.168xxxx" ], "host_status" : "ruxxxx", "host_version" : "5.13.xxxx" } }
响应示例
状态码: 200
查询主机信息请求响应成功
{ "result" : [ { "host_id" : "dc1dab7e-b045-4e77-bda4-914xxxxxx", "host_ip" : "172.16.xxxx", "host_name" : "ecs-apmtexxxxxx", "host_status" : "xxxxxx", "host_type" : "xxxxx", "host_version" : "5.13.xx.x", "update_time" : 1637223314526 } ], "total" : 1 }
状态码: 400
BadRequest 非法请求 建议根据error_msg直接修改该请求。
{ "error_code" : "LTS.1807", "error_msg" : "Invalid host 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 |
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 ListHostSolution { 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(); ListHostRequest request = new ListHostRequest(); GetHostListRequestBody body = new GetHostListRequestBody(); List<String> listFilterHostIpList = new ArrayList<>(); listFilterHostIpList.add("192.168xxxx"); List<String> listFilterHostNameList = new ArrayList<>(); listFilterHostNameList.add("ecs-xxxx"); listFilterHostNameList.add("10.66.16xxx"); GetHostListFilter filterbody = new GetHostListFilter(); filterbody.withHostNameList(listFilterHostNameList) .withHostIpList(listFilterHostIpList) .withHostStatus(GetHostListFilter.HostStatusEnum.fromValue("ruxxxx")) .withHostVersion("5.13.xxxx"); List<String> listbodyHostIdList = new ArrayList<>(); listbodyHostIdList.add("713a9f81-574b-45aa-92df-24c4caxxxxxx"); listbodyHostIdList.add("c7085aa9-2142-4ada-9f78-bf81ffxxxxxx"); body.withFilter(filterbody); body.withHostIdList(listbodyHostIdList); request.withBody(body); try { ListHostResponse response = client.listHost(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 |
# 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 = ListHostRequest() listHostIpListFilter = [ "192.168xxxx" ] listHostNameListFilter = [ "ecs-xxxx", "10.66.16xxx" ] filterbody = GetHostListFilter( host_name_list=listHostNameListFilter, host_ip_list=listHostIpListFilter, host_status="ruxxxx", host_version="5.13.xxxx" ) listHostIdListbody = [ "713a9f81-574b-45aa-92df-24c4caxxxxxx", "c7085aa9-2142-4ada-9f78-bf81ffxxxxxx" ] request.body = GetHostListRequestBody( filter=filterbody, host_id_list=listHostIdListbody ) response = client.list_host(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 |
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.ListHostRequest{} var listHostIpListFilter = []string{ "192.168xxxx", } var listHostNameListFilter = []string{ "ecs-xxxx", "10.66.16xxx", } hostStatusFilter:= model.GetGetHostListFilterHostStatusEnum().RUXXXX hostVersionFilter:= "5.13.xxxx" filterbody := &model.GetHostListFilter{ HostNameList: &listHostNameListFilter, HostIpList: &listHostIpListFilter, HostStatus: &hostStatusFilter, HostVersion: &hostVersionFilter, } var listHostIdListbody = []string{ "713a9f81-574b-45aa-92df-24c4caxxxxxx", "c7085aa9-2142-4ada-9f78-bf81ffxxxxxx", } request.Body = &model.GetHostListRequestBody{ Filter: filterbody, HostIdList: &listHostIdListbody, } response, err := client.ListHost(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
查询主机信息请求响应成功 |
400 |
BadRequest 非法请求 建议根据error_msg直接修改该请求。 |
500 |
表明服务端能被请求访问到,但是服务内部出错 |
错误码
请参见错误码。