功能介绍
查询白名单，支持过滤查询和分页查询。如未特殊说明，匹配规则为精确匹配。
接口约束
分页查询使用的参数为marker、limit、page_reverse。marker和page_reverse只有和limit一起使用时才会生效，单独使用无效。
调试
您可以在API Explorer中直接运行调试该接口。
URI
GET /v2/{project_id}/elb/whitelists
路径参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
操作用户的项目ID。 获取方法详见获取项目ID。 |
查询参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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的字符串。 |
请求消息
无
响应消息
响应参数
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
whitelists |
Array of Whitelists objects |
白名单对象列表。详见表4。 |
whitelists字段说明
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
白名单的ID。 |
|
tenant_id |
String |
白名单所在的项目ID。 支持的最大字符长度：255 |
|
listener_id |
String |
白名单关联的监听器ID。 |
|
enable_whitelist |
Boolean |
是否开启访问控制开关。 true：打开 false：关闭 |
|
whitelist |
String |
白名单IP的字符串。 |
请求示例
- 请求样例1 全量查询白名单GET https://{Endpoint}/v2/eabfefa3fd1740a88a47ad98e132d238/elb/whitelists
- 请求样例2 过滤查询监听器eabfefa3fd1740a88a47ad98e132d230关联的白名单GET https://{Endpoint}/v2/eabfefa3fd1740a88a47ad98e132d238/elb/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, "whitelist": "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, "whitelist": "192.168.12.1,192.168.1.1/24,192.168.203.18/8,100.164.5.1/24" } ] }
返回码
请参见状态码。
