全部产品
Search
文档中心

运维安全中心(堡垒机):ListHostGroupsForUser - 查询已授权或未授权的主机组列表

更新时间:Mar 01, 2024

查询指定堡垒机用户已授权或未授权的主机组列表。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-bastionhost:ListHostGroupsForUserRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
InstanceIdstring

指定要查询的用户所在堡垒机的实例 ID。

说明 您可以调用 DescribeInstances 接口获取该参数。
bastionhost-cn-st220aw****
RegionIdstring

指定要查询的用户所在堡垒机的区域 ID。

说明 区域 ID 和区域名称的对应关系,请参见地域和可用区
cn-hangzhou
Modestring

指定要查询的主机组列表的模式。取值:

  • Authorized:已授权(默认)
  • Unauthorized:未授权
Authorized
UserIdstring

指定要查询的用户 ID。

说明 您可以调用 ListUsers 接口获取该参数。
PageNumberstring

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

PageSizestring

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

说明 建议 PageSize 取值不要为空。
20
HostGroupNamestring

指定要查询的主机组名称。最多支持 128 字符,仅支持精确查询。

group

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

返回参数

名称类型描述示例值
object
TotalCountinteger

查询到的主机组总数量。

1
RequestIdstring

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

EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
HostGroupsobject []

查询到的主机组列表。

HostGroupIdstring

主机组 ID。

Commentstring

主机组的备注信息。

comment
HostGroupNamestring

主机组名称。

group

示例

正常返回示例

JSON格式

{
  "TotalCount": 1,
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "HostGroups": [
    {
      "HostGroupId": "1",
      "Comment": "comment",
      "HostGroupName": "group"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameterThe argument is invalid.参数错误
500InternalErrorAn unknown error occurred.未知错误

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