文档中心

ListUserGroups

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

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

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

请求说明

请求方式：POST
请求地址：https://open.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	否		排序信息。
InstanceId	String	是	"vbh-21****2257-6vcphcm8"	云堡垒机 ID。

ListUserGroupsFilter

参数	类型	是否必选	示例值	描述
Keyword	String	否	职能组	用户组名关键字，采用模糊匹配进行查询。

OrderBy

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

参数

类型

是否必选

示例值

描述

Key

String

否

Name

排序字段

Desc

Boolean

否

true

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

true：降序
false：升序

请求示例

POST https://open.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		用户组信息列表。
TotalCount	Long	20	返回数据列表的总量。
PageNumber	Integer	1	当前页号。
PageSize	Integer	10	每页显示的数量。

UserGroupV2

参数	类型	示例值	描述
CreateTime	String	2023-09-12 10:34:30	用户组创建时间。
UpdateTime	String	2023-09-12 10:34:30	用户组修改时间。
UserGroupName	String	职能组	用户组名称。
InstanceId	String	vbh-14********0042-wdkz	堡垒机 ID。
UserGroupId	String	6f70-d587-11ec-bae1-62******7e3	用户组 Id。
Description	String	This is 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
    }
}

错误码

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