You need to enable JavaScript to run this app.
导航
ListUsersFromUserGroup
最近更新时间:2024.04.16 19:47:32首次发布时间:2023.12.15 10:45:22

获取用户组中的用户列表,可根据用户状态、用户来源等筛选条件查询用户组中符合要求的用户列表,并且能够按字段进行排序。

请求说明

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

请求参数

参数类型是否必选示例值描述
ActionStringListUsersFromUserGroup接口名称。当前 API 的名称为 ListUsersFromUserGroup
VersionString2021-06-01接口版本。当前 API 的版本为 2021-06-01
PageNumberInteger1分页查询时的起始页码,从 1 开始,默认为 1。

PageSize

Integer

10

分页查询时每页显示的记录数。

  • 最小值:1
  • 最大值:100
  • 默认值:10
FilterObject of ListUsersFilter筛选条件。
OrderByObject of OrderBy排序规则。
UserGroupIdStringcf3****b-a0e2-11ec-ba2c-d2*****543用户组 ID。
InstanceIdStringvbh-14****0042-qt8gr7ht云堡垒机 ID。

ListUsersFilter

参数类型是否必选示例值描述

AuthPath

Array of String

Platform

用户来源。取值:

  • Platform: 从 IAM 中导入的用户。
  • AD:从 AD 服务器中导入的用户。

Status

Array of String

["Locked"]

用户状态,取值:

  • Locked:用户被锁定。当账号密码输入次数超过指定错误次数时,该账号就会被锁定。
  • Expired:用户过期。当用户不处于登录有效时间段内时,即处于此状态。
  • Enabled:用户处于启用状态。
  • Disabled:用户被禁用。
UserIdsArray of String["afca****-c11d-11ec-9ab6-8*****8d2599"]用户 ID 列表。
KeywordStringJohn用户名关键字。

OrderBy

参数类型是否必选示例值描述
KeyStringName排序字段

Desc

Boolean

true

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

  • true:降序
  • false:升序

请求示例

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"
}

返回参数

参数类型示例值描述
ItemsArray of UserV2用户信息列表。
TotalCountLong20返回数据列表的总量。
PageNumberInteger1当前页数。
PageSizeInteger10每页显示的数量。

UserV2

参数类型示例值描述
UserNameStringJohn用户名称。
DisplayNameStringJohn显示名称。
PhoneString137****3489用户电话。
EmailStringjohn@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:  有限时间段可登录。设置此值后必须设置有效登录起始时间以及有效登录结束时间。
StartTimeString2022-12-12 12:12:12有效登录起始时间。
EndTimeString2022-12-12 12:12:12有效登录结束时间。

Status

String

Enabled

用户状态,取值:

  • Locked:  用户被锁定。当账号密码输入次数超过指定错误次数时,该账号就会被锁定。
  • Expired:  用户过期。当用户不处于登录有效时间段内时,即处于此状态。
  • Enabled:  用户处于启用状态。
  • Disabled:  用户被禁用。

IsExpired

Boolean

true

用户是否过期。取值:

  • true:已过期。
  • false:未过期。
IamIdLong31**82IAM 用户的 ID。
IamAccountIdLong14****0042IAM 账户的 ID。
InstanceIdStringvbh-14****0042-8*****rzg堡垒机 ID。
CreateTimeString2022-03-01 12:12:12创建时间。
UpdateTimeString2022-03-01 12:12:12修改时间。
CreatedByStringJohn创建人。
UserIdString8a5c****-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
    }
}

错误码

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