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

文档中心

立即注册

导航

ListHostGroups

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

获取云堡垒机的主机组列表，可根据分页及主机组 ID、名称关键字等筛选条件查询云堡垒机中已存在的主机组列表，并且能够按字段进行排序。

请求说明

请求方式：POST
请求地址：https://vbh.{RegionID}.volcengineapi.com/?Action=ListHostGroups&Version=2021-06-01

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ListHostGroups	接口名称。当前 API 的名称为 `ListHostGroups`。
Version	String	是	2021-06-01	接口版本。当前 API 的版本为 `2021-06-01`。
PageNumber	Integer	否	2	分页查询时的起始页码，从 1 开始，默认为 1。
PageSize	Integer	否	10	分页查询时每页显示的记录数. 最小值：1 最大值：100 默认值：10
Filter	Object of ListHostGroupsFilter	否	{"Keyword": "word"}	筛选条件。
OrderBy	Object of OrderBy	否	{"Key": "some key", "Desc": true}	排序信息。
InstanceId	String	是	vbh-14****0042-bhjml9w7	云堡垒机 ID。

ListHostGroupsFilter

参数	类型	是否必选	示例值	描述
Keyword	String	否	keyword	模糊搜索
HostGroupIds	Array of String	否	["2e7d77da-af08-4101-867d-e44259701efb"]	主机组ID筛选

OrderBy

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

请求示例

POST https://vbh.{RegionID}.volcengineapi.com/?Action=ListHostGroups&Version=2021-06-01
Content-Type: application/json
{
    "PageNumber": 2,
    "PageSize": 10,
    "Filter": {
        "HostGroupIds": [
            "2e7d77da-af08-41**-****-e44259701efb"
        ],
        "Keyword": "vbh"
    },
    "OrderBy": {
        "Key": "Name",
        "Desc": true
    },
    "InstanceId": "vbh-14****0042-bhjml9w7"
}

返回参数

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

HostGroup

参数	类型	示例值	描述
CreateTime	String	2022-12-12 22:22:22	创建时间
UpdateTime	String	2022-12-12 22:22:22	修改时间
HostGroupName	String	test	节点组名称
InstanceId	String	vbh-1400000042-bhjml9w7	堡垒机Id
HostGroupId	String	a47aa7c9-438d-11ec-a6f0-4ad9529a3e36	Id
Description	String	description	节点组名称

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "202211302208****",
        "Action": "ListHostGroups",
        "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",
                "HostGroupName": "beijing-center",
                "InstanceId": "vbh-14****0042-bhjml9w7",
                "HostGroupId": "a47aa7c9-438d-11**-****-4ad9529a3e36",
                "Description": "host group for vbh"
            }
        ],
        "TotalCount": 22,
        "PageNumber": 1,
        "PageSize": 10
    }
}

错误码

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