查询白名单

功能介绍

查询白名单，支持过滤查询和分页查询。如未特殊说明，匹配规则为精确匹配。

接口约束

分页查询使用的参数为marker、limit、page_reverse。marker和page_reverse只有和limit一起使用时才会生效，单独使用无效。

URI

GET /v2.0/lbaas/whitelists

请求消息

表1 请求参数
参数	是否必选	参数类型	描述
marker	否	String	分页查询的起始的资源ID，表示上一页最后一条查询记录的白名单的ID。必须与limit一起使用。
limit	否	Integer	分页查询每页的白名单个数。如果不设置，则默认不分页查询所有。
page_reverse	否	Boolean	分页的顺序，true表示从后往前分页，false表示从前往后分页，默认为false。必须与limit一起使用。
id	否	String	白名单ID。
tenant_id	否	String	白名单所在的项目ID。支持的最大字符长度：255
listener_id	否	String	白名单关联的监听器ID。
enable_whitelist	否	Boolean	是否开启访问控制开关。 true：打开 false：关闭
whitelist	否	String	白名单IP的字符串。

响应消息

表2 响应参数
参数	参数类型	描述
whitelists	Array	白名单对象列表。详见表3。
whitelists_links	Array	白名单的分页查询中上下页的链接信息。仅当分页查询时响应体中有该字段。详见表4。

表3 whitelist字段说明
参数	参数类型	描述
id	String	白名单的ID。
tenant_id	String	白名单所在的项目ID。支持的最大字符长度：255
listener_id	String	白名单关联的监听器ID。
enable_whitelist	Bool	是否开启访问控制开关。 true：打开 false：关闭
whitelist	String	白名单IP的字符串。

表4 whitelists_links字段说明
参数	参数类型	描述
href	String	白名单的分页查询中上下页的链接。
rel	String	上下页的提示信息。取值范围：next、previous。next表示href是下一页的url，previous表示href是上一页的url。

请求示例

请求样例1 全量查询白名单

GET https://{Endpoint}/v2.0/lbaas/whitelists

请求样例2 过滤查询监听器eabfefa3fd1740a88a47ad98e132d230关联的白名单

GET https://{Endpoint}/v2.0/lbaas/whitelists?listener_id=eabfefa3fd1740a88a47ad98e132d230

响应示例

响应样例1

{ 
    "whitelists": [ 
        { 
            "id": "eabfefa3fd1740a88a47ad98e132d238",  
            "listener_id": "eabfefa3fd1740a88a47ad98e132d238",  
            "tenant_id": "eabfefa3fd1740a88a47ad98e132d238",  
            "enable_whitelist": true,  
            "whitelist": "192.168.11.1,192.168.0.1/24,192.168.201.18/8,100.164.0.1/24" 
        },  
        { 
            "id": "eabfefa3fd1740a88a47ad98e132d326",  
            "listener_id": "eabfefa3fd1740a88a47ad98e132d327",  
            "tenant_id": "eabfefa3fd1740a88a47ad98e132d436",  
            "enable_whitelist": true,  
            "whiltelist": "192.168.12.1,192.168.1.1/24,192.168.203.18/8,100.164.5.1/24" 
        } 
    ] 
}

响应样例2

{ 
    "whitelists": [ 
        { 
            "id": "eabfefa3fd1740a88a47ad98e132d238",  
            "listener_id": "eabfefa3fd1740a88a47ad98e132d230",  
            "tenant_id": "eabfefa3fd1740a88a47ad98e132d239",  
            "enable_whitelist": true,  
            "whitelist": "192.168.11.1,192.168.0.1/24,192.168.201.18/8,100.164.0.1/24" 
        },  
        { 
            "id": "eabfefa3fd1740a88a47ad98e132d326",  
            "listener_id": "eabfefa3fd1740a88a47ad98e132d327",  
            "tenant_id": "eabfefa3fd1740a88a47ad98e132d439",  
            "enable_whitelist": true,  
            "whiltelist": "192.168.12.1,192.168.1.1/24,192.168.203.18/8,100.164.5.1/24" 
        } 
    ] 
}