获取指定堡垒机下的用户组列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| InstanceId |
string |
是 |
指定要查询用户组列表的堡垒机实例 ID。 说明
您可以调用 DescribeInstances 接口获取该参数。 |
bastionhost-cn-st220aw**** |
| RegionId |
string |
否 |
指定要查询用户组列表的堡垒机的区域 ID。 说明
区域 ID 和区域名称的对应关系，请参见地域和可用区。 |
cn-hangzhou |
| PageNumber |
string |
否 |
指定分页查询时，当前页的页码。默认值为 1。 |
1 |
| PageSize |
string |
否 |
指定分页查询时，每页显示的数据最大条数。 说明
建议 PageSize 取值不要为空。 |
20 |
| UserGroupName |
string |
否 |
指定要查询的用户组名称。仅支持精确查询。 |
TestGroup01 |
调用 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. | 未知错误 |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。