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

文档中心

立即注册

导航

ListUserGroups

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

获取用户组列表，可根据分页及名称关键字筛选符合要求的云堡垒机用户组列表，并且能够按字段进行排序。

请求说明

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

请求参数

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

ListUserGroupsFilter

参数	类型	是否必选	示例值	描述
Keyword	String	否	keyword	模糊搜索

OrderBy

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

请求示例

POST https://vbh.{RegionID}.volcengineapi.com/?Action=ListUserGroups&Version=2021-06-01
Content-Type: application/json
{
    "PageNumber": 1,
    "PageSize": 10,
    "Filter": {
        "Keyword": "职能组"
    },
    "OrderBy": {
        "Key": "Name",
        "Desc": true
    },
    "InstanceId": "vbh-21****2257-6vcphcm8"
}

返回参数

参数	类型	示例值	描述
Items	Array of UserGroupV2	[{"CreateTime":"2022-08-10 12:34:24","UpdateTime":"2022-08-10 12:34:24","UserGroupName":"222","InstanceId":"vbh-1400000042-wxvqsx9f","UserGroupId":"749e74c0-e33e-4674-9a75-ecb832ae97db","Description":""}]	用户组信息列表。
TotalCount	Long	20	返回数据列表的总量。
PageNumber	Integer	1	当前页号。
PageSize	Integer	10	每页显示的数量。

UserGroupV2

参数	类型	示例值	描述
CreateTime	String	2022-12-12 22:22:22	创建时间
UpdateTime	String	2022-12-12 22:22:22	修改时间
UserGroupName	String	userGroup name	用户组名称
InstanceId	String	instance id	堡垒机 ID
UserGroupId	String	userGroup id	用户组 Id
Description	String	some description	描述

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "202211302208****",
        "Action": "ListUserGroups",
        "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",
                "UserGroupName": "职能组",
                "InstanceId": "vbh-14****0042-wdk****z",
                "UserGroupId": "6f7****0-d587-11ec-bae1-62******7e3",
                "Description": "This is some description"
            }
        ],
        "TotalCount": 20,
        "PageNumber": 2,
        "PageSize": 10
    }
}

错误码

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