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

查询SSH登录IP白名单列表 - ListLoginWhiteIp

功能介绍

查询SSH登录IP白名单列表

授权信息

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

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

URI

GET /v5/{project_id}/setting/login-white-ip

表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)。

white_ip

String

白名单IP/IP网段,IP网段由IP地址和掩码组成,以‘/’连接。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total_num

Integer

SSH登录IP白名单总数

data_list

Array of LoginWhiteIpResponseInfo objects

SSH登录IP白名单信息列表

表5 LoginWhiteIpResponseInfo

参数

参数类型

描述

enabled

Boolean

白名单启用状态,包含如下:

  • true:已启用

  • false:已禁用

white_ip

String

白名单IP或IP网段,IP网段由IP地址和掩码组成,以‘/’连接。

total_num

Integer

服务器ID总数

host_id_list

Array of strings

服务器ID列表

请求示例

响应示例

状态码:200

请求已成功

{
  "total_num" : 1,
  "data_list" : [ {
    "enabled" : true,
    "white_ip" : "192.78.***.0/255.255.255.0",
    "total_num" : 1,
    "host_id_list" : [ "81***56f-6264-4d3f-9c81-be8e93****ce6" ]
  } ]
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档