功能介紹
創(chuàng)建白名單，控制監(jiān)聽器的訪問權(quán)限。若開啟了白名單功能，只有白名單中放通的IP可以訪問該監(jiān)聽器的后端服務(wù)。
調(diào)試
您可以在API Explorer中直接運(yùn)行調(diào)試該接口。
URI
POST /v2/{project_id}/elb/whitelists
參數(shù)說明
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
操作用戶的項(xiàng)目ID。 獲取方法詳見獲取項(xiàng)目ID。 |
請(qǐng)求消息
請(qǐng)求參數(shù)
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
whitelist |
是 |
Whitelist object |
白名單對(duì)象。詳見 表3。 |
whitelist字段說明
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
tenant_id |
否 |
String |
白名單所在的項(xiàng)目ID。 獲取方法詳見獲取項(xiàng)目ID。 需要和token中的project_id一致。 支持的最大字符長(zhǎng)度：255 |
|
listener_id |
是 |
String |
監(jiān)聽器ID。 一個(gè)監(jiān)聽器只能創(chuàng)建一個(gè)白名單。 |
|
enable_whitelist |
否 |
Boolean |
是否開啟訪問控制開關(guān)。 true：打開 false：關(guān)閉 默認(rèn)值：true。 |
|
whitelist |
否 |
String |
白名單IP的字符串。不同IP之間通過逗號(hào)分隔。 可以指定一個(gè)IP，例如： 192.168.11.1 也可以指定網(wǎng)段，例如： 192.168.0.1/24 默認(rèn)值：“”。 |
響應(yīng)消息
響應(yīng)參數(shù)
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
whitelist |
Whitelist object |
白名單對(duì)象。詳見 表5。 |
whitelist字段說明
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
id |
String |
白名單的ID。 |
|
tenant_id |
String |
白名單所在的項(xiàng)目ID。 支持的最大字符長(zhǎng)度：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)求樣例 創(chuàng)建白名單POST https://{Endpoint}/v2/eabfefa3fd1740a88a47ad98e132d238/elb/whitelists { "whitelist": { "listener_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" } }
響應(yīng)示例
- 響應(yīng)樣例{ "whitelist": { "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" } }
返回碼
請(qǐng)參見狀態(tài)碼。
