功能介紹
查詢白名單，支持過濾查詢和分頁查詢。如未特殊說明，匹配規(guī)則為精確匹配。
接口約束
分頁查詢使用的參數(shù)為marker、limit、page_reverse。marker和page_reverse只有和limit一起使用時(shí)才會(huì)生效，單獨(dú)使用無效。
調(diào)試
您可以在API Explorer中直接運(yùn)行調(diào)試該接口。
URI
GET /v2/{project_id}/elb/whitelists
路徑參數(shù)
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
操作用戶的項(xiàng)目ID。 獲取方法詳見獲取項(xiàng)目ID。 |
查詢參數(shù)
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
marker |
否 |
String |
分頁查詢的起始的資源ID，表示上一頁最后一條查詢記錄的白名單的ID。 必須與limit一起使用。 |
|
limit |
否 |
Integer |
分頁查詢每頁的白名單個(gè)數(shù)。如果不設(shè)置，則默認(rèn)不分頁查詢所有。 |
|
page_reverse |
否 |
Boolean |
分頁的順序，true表示從后往前分頁，false表示從前往后分頁，默認(rèn)為false。 必須與limit一起使用。 |
|
id |
否 |
String |
白名單ID。 |
|
tenant_id |
否 |
String |
白名單所在的項(xiàng)目ID。 支持的最大字符長度：255 |
|
listener_id |
否 |
String |
白名單關(guān)聯(lián)的監(jiān)聽器ID。 |
|
enable_whitelist |
否 |
Boolean |
是否開啟訪問控制開關(guān)。 true：打開 false：關(guān)閉 |
|
whitelist |
否 |
String |
白名單IP的字符串。 |
請(qǐng)求消息
無
響應(yīng)消息
響應(yīng)參數(shù)
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
whitelists |
Array of Whitelists objects |
白名單對(duì)象列表。詳見表4。 |
whitelists字段說明
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
id |
String |
白名單的ID。 |
|
tenant_id |
String |
白名單所在的項(xiàng)目ID。 支持的最大字符長度：255 |
|
listener_id |
String |
白名單關(guān)聯(lián)的監(jiān)聽器ID。 |
|
enable_whitelist |
Boolean |
是否開啟訪問控制開關(guān)。 true：打開 false：關(guān)閉 |
|
whitelist |
String |
白名單IP的字符串。 |
請(qǐng)求示例
- 請(qǐng)求樣例1 全量查詢白名單GET https://{Endpoint}/v2/eabfefa3fd1740a88a47ad98e132d238/elb/whitelists
- 請(qǐng)求樣例2 過濾查詢監(jiān)聽器eabfefa3fd1740a88a47ad98e132d230關(guān)聯(lián)的白名單GET https://{Endpoint}/v2/eabfefa3fd1740a88a47ad98e132d238/elb/whitelists?listener_id=eabfefa3fd1740a88a47ad98e132d230
響應(yīng)示例
- 響應(yīng)樣例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" } ] }
- 響應(yīng)樣例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" } ] }
返回碼
請(qǐng)參見狀態(tài)碼。
