文档中心

ListUsers

最近更新时间：2024.04.16 19:47:31

首次发布时间：2023.12.15 10:45:22

查询用户列表，可根据分页及用户来源、用户状态等筛选条件查询符合要求的云堡垒机用户列表，并且能够按字段进行排序。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Action=ListUsers&Version=2021-06-01

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ListUsers	接口名称。当前 API 的名称为 `ListUsers`。
Version	String	是	2021-06-01	接口版本。当前 API 的版本为 `2021-06-01`。
PageNumber	Integer	否	1	分页查询时的起始页码，从 1 开始，默认为 1。
PageSize	Integer	否	10	分页查询时每页显示的记录数。最小值：1 最大值：100 默认值：10
Filter	Object of ListUsersFilter	否	{"Status": ["Enabled"]}	筛选条件。
OrderBy	Object of OrderBy	否	{"Key": "Name", "Desc": true}	排序规则。Key 指定排序字段，Desc 指定是否根据该字段降序排列。
InstanceId	String	是	vbh-14**0042-8kcrs***	云堡垒机实例 ID。

ListUsersFilter

参数	类型	是否必选	示例值	描述
AuthPath	Array of String	否	Platform	用户来源。取值： Platform：从 IAM 中导入的用户。 AD：从 AD 服务器中导入的用户。
Status	Array of String	否	["Locked"]	用户状态，取值： Locked：用户被锁定。当账号密码输入次数超过指定错误次数时，该账号就会被锁定。 Expired：用户过期。当用户不处于登录有效时间段内时，即处于此状态。 Enabled：用户处于启用状态。 Disabled：用户被禁用。
UserIds	Array of String	否	["afca**-c11d-11ec-9ab6-8***8d2599"]	用户 ID 列表。
Keyword	String	否	John	用户名关键字。

OrderBy

参数	类型	是否必选	示例值	描述
Key	String	否	Name	排序字段
Desc	Boolean	否	true	是否进行降序排列。取值: true：降序 false：升序

参数

类型

是否必选

示例值

描述

Key

String

否

Name

排序字段

Desc

Boolean

否

true

是否进行降序排列。取值:

true：降序
false：升序

请求示例

POST https://open.volcengineapi.com/?Action=ListUsers&Version=2021-06-01
Content-Type: application/json
{
    "PageNumber": 1,
    "PageSize": 10,
    "Filter": {
        "AuthPath": "Platform",
        "Status": ["Locked"],
        "UserIds": ["afc****c-c11d-11ec-9ab6-8e6******599"],
        "Keyword": "John"
    },
    "OrderBy": {
        "Key": "Name",
        "Desc": true
    },
    "InstanceId": "vbh-14****0042-8****rzg"
}

返回参数

参数	类型	示例值	描述
Items	Array of UserV2		用户信息列表。
TotalCount	Long	20	返回数据列表的总量。
PageNumber	Integer	1	当前页数。
PageSize	Integer	10	每页显示的数量。

UserV2

参数	类型	示例值	描述
UserName	String	John	用户名称。
DisplayName	String	John	显示名称。
Phone	String	137****3489	用户电话。
Email	String	john@exmaple.com	用户邮箱。
AuthPath	String	Platform	用户来源，取值： Platform：从 IAM 中导入的用户。 AD：从 AD 服务器中导入的用户。
Password	String	Password11@	云堡垒机登录密码。说明用户来源为 Platform 时，导入用户会默认生成一个云堡垒机登录密码，支持修改。用户来源为 AD 时，直接使用 AD 用户原始密码，不支持修改。
Enable	Boolean	true	是否启用该用户，取值: true：启用该用户。 false：禁用该用户。
FullTime	Boolean	true	是否全时段可登录，取值： true：全时段可登录。设置此值则不需要设置有效登录起始时间以及有效登录结束时间。 false：有限时间段可登录。设置此值后必须设置有效登录起始时间以及有效登录结束时间。
StartTime	String	2022-12-12 12:12:12	有效登录起始时间。
EndTime	String	2022-12-12 12:12:12	有效登录结束时间。
Status	String	Enabled	用户状态，取值： Locked：用户被锁定。当账号密码输入次数超过指定错误次数时，该账号就会被锁定。 Expired：用户过期。当用户不处于登录有效时间段内时，即处于此状态。 Enabled：用户处于启用状态。 Disabled：用户被禁用。
IsExpired	Boolean	true	用户是否过期。取值： true：已过期。 false：未过期。
IamId	Long	31**82	IAM 用户的 ID。
IamAccountId	Long	14****0042	IAM 账户的 ID。
InstanceId	String	vbh-14**0042-8***rzg	堡垒机 ID。
CreateTime	String	2022-03-01 12:12:12	创建时间。
UpdateTime	String	2022-03-01 12:12:12	修改时间。
CreatedBy	String	John	创建人。
UserId	String	8a5c**-c489-11ec-b5a4-3e3***a490	用户 ID。

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202211302208****",
        "Action": "ListUsers",
        "Version": "2021-06-01",
        "Service": "vbh",
        "Region": "cn-beijing"
    },
    "Result": {
        "Items": [
            {
                "UserName": "John",
                "DisplayName": "John",
                "Phone": "137****3489",
                "Email": "john@example.com",
                "AuthPath": "Platform",
                "Password": "Password11@",
                "Enable": true,
                "FullTime": true,
                "StartTime": "2022-12-12 12:12:12",
                "EndTime": "2022-12-12 12:12:12",
                "Status": "Enabled",
                "IsExpired": true,
                "IamId": 31**82,
                "IamAccountId": 14****0042,
                "InstanceId": "vbh-14****0042-8****rzg",
                "CreateTime": "2022-03-01 12:12:12",
                "UpdateTime": "2022-03-01 12:12:12",
                "CreatedBy": "John",
                "UserId": "8a5c****-c489-11ec-b5a4-3e3*****a490"
            }
        ],
        "TotalCount": 22,
        "PageNumber": 2,
        "PageSize": 33
    }
}

错误码

当前接口暂无独立错误码，若接口调用返回异常，可参考公共错误码进行故障排查。