文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 白名单管理/ 查询登录白名单列表 - ListLoginWhiteList
更新时间:2025-10-31 GMT+08:00
分享

查询登录白名单列表 - ListLoginWhiteList

功能介绍

查询登录白名单列表

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v5/{project_id}/event/white-list/login

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID

如需查询所有企业项目下的资产请传参“all_granted_eps”。

约束限制:

开通企业项目功能后才需要配置企业项目ID参数。

取值范围:

字符长度1-256位

默认取值:

0,表示默认企业项目(default)。

private_ip

String

参数解释:

服务器私有IP

约束限制:

不涉及

取值范围:

字符长度1-128位

默认取值:

不涉及

login_ip

String

登录源IP

login_user_name

String

登录用户名

offset

Integer

参数解释:

偏移量:指定返回记录的开始位置

约束限制:

不涉及

取值范围:

最小值0,最大值2000000

默认取值:

不涉及

limit

Integer

参数解释:

每页显示个数

约束限制:

不涉及

取值范围:

取值10-200

默认取值:

10

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total_num

Integer

参数解释:

总数

取值范围:

最小值0,最大值2147483647

data_list

Array of LoginWhiteListResponseInfo objects

登录白名单详情

表5 LoginWhiteListResponseInfo

参数

参数类型

描述

private_ip

String

参数解释

服务器私有IP

取值范围

字符长度1-128位

login_ip

String

参数解释

登录源IP

取值范围

字符长度1-256位

login_user_name

String

参数解释

登录用户名

取值范围

字符长度1-256位

update_time

Integer

更新时间,毫秒

remarks

String

备注

enterprise_project_name

String

企业项目名称

请求示例

查询登录白名单列表

/v5/{project_id}/event/white-list/login?offset=0&limit=200&enterprise_project_id=xxx

响应示例

状态码:200

请求已成功

{
  "total_num" : 1,
  "data_list" : [ {
    "private_ip" : "10.112.30.241",
    "login_ip" : "10.112.30.241",
    "login_user_name" : "root",
    "enterprise_project_name" : "所有项目",
    "update_time" : 1730880418578
  } ]
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档