Updating a Forwarding Policy
Function
This API is used to update a forwarding policy. You can select another backend server group or redirect to another HTTPS listener.
URI
PUT /v2.0/lbaas/l7policies/{l7policy_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
l7policy_id |
Yes |
Object |
Specifies the forwarding policy ID. |
Request
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
l7policy |
Yes |
Object |
Specifies the forwarding policy. For details, see Table 3. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
No |
String |
Specifies the forwarding policy name. The value contains a maximum of 255 characters. |
description |
No |
String |
Provides supplementary information about the forwarding policy. The value contains a maximum of 255 characters. |
redirect_pool_id |
No |
String |
Specifies the ID of the backend server group to which traffic is forwarded. The default value is null. This parameter is mandatory when action is set to REDIRECT_TO_POOL. This parameter cannot be specified when action is set to REDIRECT_TO_LISTENER. The backend server group must meet the following requirements:
|
redirect_listener_id |
No |
String |
Specifies the ID of the listener to which the traffic is redirected. The default value is null. This parameter is mandatory when action is set to REDIRECT_TO_LISTENER. This parameter cannot be specified when action is set to REDIRECT_TO_POOL. The listener must meet the following requirements:
|
admin_state_up |
No |
Boolean |
Specifies the administrative status of the forwarding policy. This parameter is reserved, and the default value is true. |
Response
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
l7policy |
Yes |
Object |
Specifies the forwarding policy. For details, see Table 5. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Specifies the forwarding policy ID. |
tenant_id |
String |
Specifies the ID of the project where the forwarding policy is used. |
name |
String |
Specifies the forwarding policy name. |
admin_state_up |
Boolean |
Specifies the administrative status of the forwarding policy. This parameter is reserved. The value can be true or false.
|
description |
String |
Provides supplementary information about the forwarding policy. |
listener_id |
String |
Specifies the ID of the listener to which the forwarding policy is added. |
action |
String |
Specifies whether requests are forwarded to another backend server group or redirected to an HTTPS listener. The value can be one of the following:
|
redirect_pool_id |
String |
Specifies the ID of the backend server group to which traffic is forwarded. |
redirect_listener_id |
String |
Specifies the ID of the listener to which the traffic is redirected. |
redirect_url |
String |
Specifies the URL to which traffic is redirected. This parameter is reserved. |
rules |
Array |
Lists the forwarding rules of the forwarding policy. For details, see Table 6. |
position |
Integer |
Specifies the forwarding priority. The value ranges from 1 to 100. The default value is 100. This parameter is reserved. |
provisioning_status |
String |
This parameter is reserved, and its value can only be ACTIVE. It specifies the provisioning status of the forwarding policy. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Lists the IDs of the forwarding rules in the forwarding policy. |
Example Request
- Example request: Updating a forwarding policy
PUT https://{Endpoint}/v2.0/lbaas/l7policies/5ae0e1e7-5f0f-47a1-b39f-5d4c428a1586 { "l7policy": { "name": "test" } }
Example Response
- Example response
{ "l7policy": { "redirect_pool_id": "431a03eb-81bb-408e-ae37-7ce19023692b", "redirect_listener_id": null, "description": "", "admin_state_up": true, "rules": [ { "id": "67d8a8fa-b0dd-4bd4-a85b-671db19b2ef3" }, { "id": "f02b3bca-69d2-4335-a3fa-a8054e996213" } ], "tenant_id": "a31d2bdcf7604c0faaddb058e1e08819", "listener_id": "26058b64-6185-4e06-874e-4bd68b7633d0", "redirect_url": null, "action": "REDIRECT_TO_POOL", "provisioning_status": "ACTIVE", "position": 2, "id": "5ae0e1e7-5f0f-47a1-b39f-5d4c428a1586", "name": "test" } }
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