获取指定堡垒机的用户列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| yundun-bastionhost:ListUsers | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| InstanceId | string | 是 | 指定要查询用户列表的堡垒机的实例 ID。 说明
您可以调用 DescribeInstances 接口获取该参数。
| bastionhost-cn-st220aw**** |
| RegionId | string | 否 | 指定要查询用户列表的堡垒机的区域 ID。 说明
区域 ID 和区域名称的对应关系，请参见地域和可用区。
| cn-hangzhou |
| PageNumber | string | 否 | 指定分页查询时，当前页的页码。默认值为 1。 | 1 |
| PageSize | string | 否 | 指定分页查询时，每页显示的数据最大条数。 说明
建议 PageSize 取值不要为空。
| 20 |
| UserName | string | 否 | 指定要查询的用户登录名称。仅支持精确查询。 | abc |
| DisplayName | string | 否 | 指定要查询的用户显示姓名。仅支持精确查询。 | 用户 |
| Source | string | 否 | 指定要查询的用户的来源。取值：
| Local |
| Mobile | string | 否 | 指定要查询的用户的手机号码。仅支持精确查询。 | 1359999**** |
| UserState | string | 否 | 指定要查询的用户状态。取值：
| Normal |
| SourceUserId | string | 否 | 指定要查询的用户的唯一标识。仅支持精确查询。 说明
该参数是堡垒机用户对应的 RAM 用户的唯一标识。新创建用户来源为 RAM 用户（即 Source 取值为 Ram）时，该参数生效。您可以调用访问控制的 ListUsers 接口从返回数据 UserId 获取该参数。
| 122748924538**** |
| UserGroupId | string | 否 | 指定要查询的用户组 ID。 说明
您可以调用 ListUserGroups 接口获取该参数。
| 1 |
调用 API 时，除了本文中该 API 的请求参数，还需加入阿里云 API 公共请求参数。公共请求参数的详细介绍，请参见公共参数。 调用 API 的请求格式，请参见本文示例中的请求示例。
返回参数
示例
正常返回示例
JSON格式
{
"TotalCount": 1,
"RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
"Users": [
{
"DisplayName": "Bob",
"Email": "1099**@qq.com",
"Comment": "comment",
"MobileCountryCode": "CN",
"Mobile": "1359999****",
"UserId": "1",
"Source": "Local",
"UserName": "abc_def",
"SourceUserId": "122748924538****",
"UserState": [
"[\"Normal\"]"
],
"EffectiveStartTime": 1669630029,
"EffectiveEndTime": 1672502400,
"NeedResetPassword": true,
"TwoFactorStatus": "Enable",
"TwoFactorMethods": [
"[\n \"sms\"\n]"
],
"LanguageStatus": "Custom",
"Language": "en"
}
]
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidParameter | The argument is invalid. | 参数错误 |
| 500 | InternalError | An unknown error occurred. | 未知错误 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-02-28 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |