Adding a Whitelist
Function
This API is used to add a whitelist to control access to a specific listener. After a whitelist is added, only IP addresses in the whitelist can access the listener.
URI
POST /v2/{project_id}/elb/whitelists
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Specifies the project ID. |
Request
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
whitelist |
Yes |
Whitelist object |
Specifies the whitelist. For details, see Table 3. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
tenant_id |
No |
String |
Specifies the ID of the project where the whitelist is used. The value must be the same as the value of project_id in the token. The value contains a maximum of 255 characters. |
listener_id |
Yes |
String |
Specifies the listener ID. Only one whitelist can be created for a listener. |
enable_whitelist |
No |
Boolean |
Specifies whether to enable access control. true: Access control is enabled. false: Access control is disabled. The default value is true. |
whitelist |
No |
String |
Specifies the IP addresses in the whitelist. Use commas (,) to separate multiple IP addresses. You can specify an IP address, for example, 192.168.11.1. You can also specify an IP address range, for example, 192.168.0.1/24. The default value is an empty string, that is, "". |
Response
Parameter |
Type |
Description |
---|---|---|
whitelist |
Whitelist object |
Specifies the whitelist. For details, see Table 5. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Specifies the whitelist ID. |
tenant_id |
String |
Specifies the ID of the project where the whitelist is used. The value contains a maximum of 255 characters. |
listener_id |
String |
Specifies the ID of the listener to which the whitelist is added. |
enable_whitelist |
Boolean |
Specifies whether to enable access control. true: Access control is enabled. false: Access control is disabled. |
whitelist |
String |
Specifies the IP addresses in the whitelist. |
Example Request
- Example request: Adding a whitelist
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" } }
Example Response
- Example response
{ "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" } }
Status Code
For details, see Status Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot