ListHosts--云堡垒机-火山引擎

导航

ListHosts

最近更新时间：2025.05.23 17:57:31首次发布时间：2023.12.15 10:45:21

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

请求说明

请求方式：POST
请求地址：https://vbh.{RegionID}.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	否	{"Keyword": "word"}	待查询主机的筛选条件。
OrderBy	Object of OrderBy	否	{"Key": "some key", "Desc": true}	排序信息。
InstanceId	String	是	vbh-14****0042-bhjml9w7	云堡垒机实例 ID。

ListHostsFilter

参数	类型	是否必选	示例值	描述
VpcId	String	否	vpc-bp1qpo0kug3a20qqefdks	Vpc ID
OsType	Array of String	否	Linux" 或 "Windows	机器系统
Source	Array of String	否	local" 或 "volc	主机来源
HostIds	Array of String	否	["2fad258f-9dc9-11ec-ab65-4645cf75c406"]	主机ID筛选
Keyword	String	否	keyword	模糊搜索

OrderBy

参数	类型	是否必选	示例值	描述
Key	String	否	key	字段
Desc	Boolean	否	true or false	倒序

请求示例

POST https://vbh.{RegionID}.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	[{"CreateTime":"2022-09-13 11:25:26","UpdateTime":"2022-09-13 11:25:26","HostName":"ECS-se23","Ip":"172.16.0.238","OsType":"Linux","Source":"volc","InstanceId":"vbh-1400000042-wxvqsx9f","HostId":"ddeca1e5-c721-47d8-bf58-b3e3fe1b70a7","Protocol":"ssh","Port":22,"VpcName":"v172","VpcId":"vpc-3reyos6qtqfwg5zsk2hn63665"}]	主机信息列表。
TotalCount	Long	22	返回数据列表的总量。
PageNumber	Integer	1	当前页数。
PageSize	Integer	10	每页显示的数量。

Host

参数	类型	示例值	描述
CreateTime	String	2022-12-12 22:22:22	创建时间
UpdateTime	String	2022-12-12 22:22:22	修改时间
HostName	String	test	主机名
Ip	String	2.2.2.2	主机名
OsType	String	Linux	机器系统
Source	String	volc	导入源
InstanceId	String	vbh-1400000042-bhjml9w7	堡垒机Id
HostId	String	a47aa7c9-438d-11ec-a6f0-4ad9529a3e36	Id
Protocol	String	ssh	连接协议
Port	Long	65535	连接端口
VpcName	String	test	VPC名称
VpcId	String	vpc-3reyos6qtqfwg5zsk2hn63665	VPCId

返回示例

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
    }
}

错误码

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