全部产品
Search

搜索本产品

    运维安全中心（堡垒机）：ListUserGroups - 获取用户组列表

    文档中心

    运维安全中心（堡垒机）：ListUserGroups - 获取用户组列表

    更新时间：Sep 29, 2026

    获取指定堡垒机下的用户组列表。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    调试

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。

    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

      • 对于必选的资源类型，用前面加 * 表示。

      • 对于不支持资源级授权的操作，用全部资源表示。

    • 条件关键字：是指云产品自身定义的条件关键字。

    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

    操作

    访问级别

    资源类型

    条件关键字

    关联操作

    yundun-bastionhost:ListUserGroups

    get

    *Instance

    acs:yundun-bastionhost:{#regionId}:{#accountId}:instance/{#InstanceId}

    		 无 无

    请求参数

    名称

    类型

    必填

    描述

    示例值
    InstanceId

    string

    是

    指定要查询用户组列表的堡垒机实例 ID。

    说明

    您可以调用 DescribeInstances 接口获取该参数。

    bastionhost-cn-st220aw****
    RegionId

    string

    否

    指定要查询用户组列表的堡垒机的区域 ID。

    说明

    区域 ID 和区域名称的对应关系，请参见地域和可用区。

    cn-hangzhou
    PageNumber

    string

    否

    指定分页查询时，当前页的页码。默认值为 1。

    1
    PageSize

    string

    否

    指定分页查询时，每页显示的数据最大条数。
    PageSize 参数最大取值为 100。每页默认显示的数据条数为 20 条，PageSize 参数值为空时，将默认返回 20 条数据。

    说明

    建议 PageSize 取值不要为空。

    20
    UserGroupName

    string

    否

    指定要查询的用户组名称。仅支持精确查询。

    TestGroup01
    ProjectId

    integer

    否

    项目 ID

    3

    调用 API 时，除了本文中该 API 的请求参数，还需加入阿里云 API 公共请求参数。公共请求参数的详细介绍，请参见公共参数。 调用 API 的请求格式，请参见本文示例中的请求示例。

    返回参数

    名称

    类型

    描述

    示例值

    object

    响应数据。

    TotalCount

    integer

    查询到的用户组总数。

    1
    RequestId

    string

    阿里云为该请求生成的唯一标识符。

    EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
    UserGroups

    array<object>

    查询到的用户组列表。

    object

    UserGroupName

    string

    用户组名称。

    TestGroup01
    MemberCount

    integer

    用户组内的用户数量。

    6
    Comment

    string

    用户组备注信息。

    comment
    UserGroupId

    string

    用户组 ID。

    1

    示例

    正常返回示例

    JSON格式

    {
  "TotalCount": 1,
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "UserGroups": [
    {
      "UserGroupName": "TestGroup01",
      "MemberCount": 6,
      "Comment": "comment",
      "UserGroupId": "1"
    }
  ]
}

    错误码

    HTTP status code

    错误码

    错误信息

    描述
    400 InvalidParameter The argument is invalid. 参数错误
    500 InternalError An unknown error occurred. 未知错误

    访问错误中心查看更多错误码。

    变更历史

    更多信息，参考变更详情。