获取用户组中的用户列表,可根据用户状态、用户来源等筛选条件查询用户组中符合要求的用户列表,并且能够按字段进行排序。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListUsersFromUserGroup | 接口名称。当前 API 的名称为 ListUsersFromUserGroup 。 |
Version | String | 是 | 2021-06-01 | 接口版本。当前 API 的版本为 2021-06-01 。 |
PageNumber | Integer | 否 | 1 | 分页查询时的起始页码,从 1 开始,默认为 1。 |
PageSize | Integer | 否 | 10 | 分页查询时每页显示的记录数。
|
Filter | Object of ListUsersFilter | 否 | 筛选条件。 | |
OrderBy | Object of OrderBy | 否 | 排序规则。 | |
UserGroupId | String | 是 | cf3****b-a0e2-11ec-ba2c-d2*****543 | 用户组 ID。 |
InstanceId | String | 是 | vbh-14****0042-qt8gr7ht | 云堡垒机 ID。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
AuthPath | Array of String | 否 | Platform | 用户来源。取值:
|
Status | Array of String | 否 | ["Locked"] | 用户状态,取值:
|
UserIds | Array of String | 否 | ["afca****-c11d-11ec-9ab6-8*****8d2599"] | 用户 ID 列表。 |
Keyword | String | 否 | John | 用户名关键字。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Key | String | 否 | Name | 排序字段 |
Desc | Boolean | 否 | true | 是否进行降序排列。取值:
|
POST https://open.volcengineapi.com/?Action=ListUsersFromUserGroup&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 }, "UserGroupId": "cf3****b-a0e2-11ec-ba2c-d2******543", "InstanceId": "vbh-14****0042-qt8gr7ht" }
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Items | Array of UserV2 | 用户信息列表。 | |
TotalCount | Long | 20 | 返回数据列表的总量。 |
PageNumber | Integer | 1 | 当前页数。 |
PageSize | Integer | 10 | 每页显示的数量。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
UserName | String | John | 用户名称。 |
DisplayName | String | John | 显示名称。 |
Phone | String | 137****3489 | 用户电话。 |
String | john@exmaple.com | 用户邮箱。 | |
AuthPath | String | Platform | 用户来源,取值:
|
Password | String | Password11@ | 云堡垒机登录密码。 说明
|
Enable | Boolean | true | 是否启用该用户,取值:
|
FullTime | Boolean | true | 是否全时段可登录,取值:
|
StartTime | String | 2022-12-12 12:12:12 | 有效登录起始时间。 |
EndTime | String | 2022-12-12 12:12:12 | 有效登录结束时间。 |
Status | String | Enabled | 用户状态,取值:
|
IsExpired | Boolean | true | 用户是否过期。取值:
|
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。 |
HTTP/1.1 200 OK Content-Type:application/json { "ResponseMetadata": { "RequestId": "202211302208****", "Action": "ListUsersFromUserGroup", "Version": "2021-06-01", "Service": "vbh", "Region": "cn-beijing" }, "Result": { "Items": [ { "UserName": "John", "DisplayName": "user", "Phone": "137****889", "Email": "john@exmaple.com", "AuthPath": "Platform", "Password": "Passw0rd", "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-wdk****z", "CreateTime": "2022-03-01 12:12:12", "UpdateTime": "2022-03-01 12:12:12", "CreatedBy": "John", "UserId": "21ee9****-c5f2-11ec-8825-925******c6f" } ], "TotalCount": 22, "PageNumber": 2, "PageSize": 33 } }
当前接口暂无独立错误码,若接口调用返回异常,可参考 公共错误码 进行故障排查。