调用ListUserGroups接口获取指定堡垒机下的用户组列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListUserGroups |
需要执行的操作。 取值:ListUserGroups。 |
InstanceId | String | 是 | bastionhost-cn-st220aw**** |
指定要查询用户组列表的堡垒机实例ID。 说明 您可以调用DescribeInstances接口获取该参数。
|
RegionId | String | 否 | cn-hangzhou |
指定要查询用户组列表的堡垒机的区域ID。 说明 区域ID和区域名称的对应关系,请参见地域和可用区。
|
PageNumber | String | 否 | 1 |
指定分页查询时,当前页的页码。默认值为1。 |
PageSize | String | 否 | 20 |
指定分页查询时,每页显示的数据最大条数。 PageSize参数最大取值为100。每页默认显示的数据条数为20条,PageSize参数值为空时,将默认返回20条数据。 说明 建议PageSize取值不要为空。
|
UserGroupName | String | 否 | TestGroup01 |
指定要查询的用户组名称。仅支持精确查询。 |
调用API时,除了本文中该API的请求参数,还需加入阿里云API公共请求参数。公共请求参数的详细介绍,请参见公共参数。
调用API的请求格式,请参见本文示例中的请求示例。
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | EC9BF0F4-8983-491A-BC8C-1B4DD94976DE |
阿里云为该请求生成的唯一标识符。 |
TotalCount | Integer | 1 |
查询到的用户组总数。 |
UserGroups | Array of Item |
查询到的用户组列表。 |
|
Comment | String | comment |
用户组备注信息。 |
MemberCount | Integer | 5 |
用户组内的用户数量。 |
UserGroupId | String | 1 |
用户组ID。 |
UserGroupName | String | TestGroup01 |
用户组名称。 |
示例
请求示例
http(s)://[Endpoint]/?Action=ListUserGroups
&InstanceId=bastionhost-cn-st220aw****
&<公共请求参数>
正常返回示例
XML
格式
<ListUserGroupsResponse>
<TotalCount>1</TotalCount>
<RequestId>EC9BF0F4-8983-491A-BC8C-1B4DD94976DE</RequestId>
<UserGroups>
<Comment>comment</Comment>
<UserGroupName>TestGroup01</UserGroupName>
<UserGroupId>1</UserGroupId>
<MemberCount>5</MemberCount>
</UserGroups>
</ListUserGroupsResponse>
JSON
格式
{
"TotalCount": "1",
"RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
"UserGroups": [{
"Comment": "comment",
"UserGroupName": "TestGroup01",
"UserGroupId": "1",
"MemberCount": "5"
}]
}
错误码
访问错误中心查看更多错误码。