Updating a Whitelist
Function
This API is used to update a whitelist. You can enable or disable the whitelist function or change IP addresses in the whitelist. If you change IP addresses in the whitelist, it will be deleted, and a new one is generated.
URI
PUT /v2/{project_id}/elb/whitelists/{whitelist_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Specifies the project ID. |
whitelist_id |
Yes |
String |
Specifies the whitelist ID. |
Request
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
whitelist |
Yes |
Whitelist object |
Specifies the whitelist. For details, see Table 3. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
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: Updating a whitelist
PUT https://{Endpoint}/v2/eabfefa3fd1740a88a47ad98e132d238/elb/whitelists/dcaf46f1-037c-4f63-a31f-e0c4c18032c7 { "whitelist": { "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