文档中心

ListHosts

最近更新时间：2024.04.16 19:47:29

首次发布时间：2023.12.15 10:45:21

获取主机列表，可根据分页及主机来源、操作系统等条件筛选云堡垒机实例所管理的主机列表，并且能够按字段进行排序。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Action=ListHosts&Version=2021-06-01

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ListHosts	接口名称。当前 API 的名称为 `ListHosts`。
Version	String	是	2021-06-01	接口版本。当前 API 的版本为 `2021-06-01`。
PageNumber	Integer	否	1	分页查询时的起始页码，从 1 开始，默认为 1。
PageSize	Integer	否	10	分页查询时每页显示的记录数。最小值：1 最大值：100 默认值：10
Filter	Object of ListHostsFilter	否		待查询主机的筛选条件。
OrderBy	Object of OrderBy	否		排序信息。
InstanceId	String	是	vbh-14****0042-bhjml9w7	云堡垒机实例 ID。

ListHostsFilter

参数	类型	是否必选	示例值	描述
Source	Array of String	否	["local","volc"]	主机来源。取值: volc：火山引擎 ECS 主机。 local：本地主机，通过其它来源导入的主机。
OsType	Array of String	否	["Linux"]	主机操作系统类型。取值: Linux Windows
HostIds	Array of String	否	["2fad258f-9dc9-11ec-ab-****75c406"]	主机 ID 列表。
Keyword	String	否	host-windows	主机名关键字。

OrderBy

参数	类型	是否必选	示例值	描述
Key	String	否	Name	排序字段
Desc	Boolean	否	true	是否进行降序排列。取值: true：降序 false：升序

参数

类型

是否必选

示例值

描述

Key

String

否

Name

排序字段

Desc

Boolean

否

true

是否进行降序排列。取值:

true：降序
false：升序

请求示例

POST https://open.volcengineapi.com/?Action=ListHosts&Version=2021-06-01
Content-Type: application/json
{
    "PageNumber": 1,
    "PageSize": 10,
    "Filter": {
        "Source": ["local","volc"],
        "OsType": ["Linux"],
        "HostIds": ["2fad258f-9dc9-11ec-ab**-****cf75c406"],
        "Keyword": "vbh"
    },
    "OrderBy": {
        "Key": "Name",
        "Desc": true
    },
    "InstanceId": "vbh-14****0042-bhjml9w7"
}

返回参数

参数	类型	示例值	描述
Items	Array of Host		主机信息列表。
TotalCount	Long	22	返回数据列表的总量。
PageNumber	Integer	1	当前页数。
PageSize	Integer	10	每页显示的数量。

Host

参数	类型	示例值	描述
CreateTime	String	2023-09-12 10:34:30	主机创建/导入时间。
UpdateTime	String	2023-09-12 10:34:30	主机修改时间。
HostName	String	host-1	主机名。
Ip	String	192.168.3.123	主机IP地址。
OsType	String	Linux	主机操作系统类型。取值: Linux Windows
Source	String	volc	主机来源。取值: volc：火山引擎 ECS 主机。 local：本地主机，通过其它来源导入的主机。
InstanceId	String	vbh-1400000*-*l9w7	云堡垒机实例 ID。
HostId	String	a47aa7c9-438d-**-f0-4ad9529a3e36	主机 ID。
Protocol	String	SSH	支持的连接协议。取值: SSH：可通过 SSH 协议连接 Linux 主机。 RDP：可通过 RDP 协议连接 Windows 主机。
Port	Long	22	主机协议连接端口，例如：SSH 协议的默认端口为 22。
VpcName	String	vpc-beer-mlt	VPC 名称。
VpcId	String	3reyos6******5zsk2hn63665	VPC ID。

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "202211302208****",
        "Action": "ListHosts",
        "Version": "2021-06-01",
        "Service": "vbh",
        "Region": "cn-beijing"
    },
    "Result": {
        "Items": [
            {
                "CreateTime": "2023-09-12 10:34:30",
                "UpdateTime": "2023-09-12 10:34:30",
                "HostName": "node-ecs",
                "Ip": "192.168.3.123",
                "OsType": "Linux",
                "Source": "volc",
                "InstanceId": "vbh-14000****-**jml9w7",
                "HostId": "a47aa7c9-438d-11**-****-4ad9529a3e36",
                "Protocol": "SSH",
                "Port": 22,
                "VpcName": "vpc-beer-mlt",
                "VpcId": "vpc-3reyos******5zsk2hn63665"
            }
        ],
        "TotalCount": 22,
        "PageNumber": 1,
        "PageSize": 10
    }
}

错误码

当前接口暂无独立错误码，若接口调用返回异常，可参考公共错误码进行故障排查。