• Elastic Load Balancing

elb
  1. Help Center
  2. Elastic Load Balancing
  3. API Reference
  4. Enhanced Load Balancer APIs
  5. L7 Policy (Forwarding Policy)
  6. Modifying a Forwarding Policy

Modifying a Forwarding Policy

Function

This API is used to modify a forwarding policy. You can change the listener or backend server group.

URI

PUT /v2.0/lbaas/l7policies/{l7policy_id}

Table 1 Parameter description

Parameter

Type

Mandatory

Description

l7policy_id

Uuid

Yes

Specifies the forwarding policy ID.

Request

  • Request parameters
    Table 2 Request parameters

    Parameter

    Type

    Mandatory

    Description

    l7policy

    Dict

    Yes

    Specifies the forwarding policy. For details, see Table 3.

    Table 3 l7policy field description

    Parameter

    Type

    Mandatory

    Description

    name

    String (255)

    No

    Specifies the forwarding policy name.

    description

    String (255)

    No

    Provides supplementary information about the forwarding policy.

    redirect_pool_id

    Uuid

    No

    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:

    • Cannot be the default backend server group of the listener.
    • Cannot be the backend server group used by forwarding policies of other listeners.

    redirect_listener_id

    Uuid

    No

    Specifies the ID of the listener that forwards the traffic. 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.

    • Can only be an HTTPS listener.
    • Can only be a listener of the same load balancer.

    admin_state_up

    Bool

    No

    Specifies the administrative status of the forwarding policy.

    The value can be true or false.

    This parameter is reserved and has been not used. The default value is true.

  • Example request
    PUT https://{Endpoint}/v2.0/lbaas/l7policies/5ae0e1e7-5f0f-47a1-b39f-5d4c428a1586
    
    {
        "l7policy": {
            "name": "test"
        }
    }

Response

  • Response parameters
    Table 4 Response parameters

    Parameter

    Type

    Mandatory

    Description

    l7policy

    Dict

    Yes

    Specifies the forwarding policy. For details, see Table 5.

    Table 5 l7policy field description

    Parameter

    Type

    Description

    id

    Uuid

    Specifies the forwarding policy ID.

    tenant_id

    String (255)

    Specifies the ID of the project where the forwarding policy is used.

    name

    String (255)

    Specifies the forwarding policy name.

    admin_state_up

    Bool

    Specifies the administrative status of the forwarding policy.

    The value can be true or false.

    This parameter is reserved and has been not used. The default value is true.

    description

    String (255)

    Provides supplementary information about the forwarding policy.

    listener_id

    Uuid

    Specifies the ID of the listener to which the forwarding policy is added.

    action

    String

    Specifies the matching action of the forwarding policy.

    The value can be one of the following:

    • REDIRECT_TO_POOL: forwards traffic to the backend server group specified by redirect_pool_id.
    • REDIRECT_TO_LISTENER: redirects traffic from the HTTP listener specified by listener_id to the HTTPS listener specified by redirect_listener_id.

    redirect_pool_id

    Uuid

    Specifies the ID of the backend server group to which traffic is forwarded.

    redirect_listener_id

    Uuid

    Specifies the ID of the listener that forwards the traffic.

    redirect_url

    String (255)

    Specifies the URL to which traffic is redirected.

    This parameter is reserved and has been not used.

    rules

    List

    Lists the forwarding rules associated with the forwarding policy.

    position

    Int

    Specifies the forwarding priority. The value ranges from 1 to 100. The default value is 100.

    This parameter is reserved and has been not used.

    provisioning_status

    String (16)

    Specifies the provisioning status of the forwarding policy. The value can be ACTIVE, PENDING_CREATE, or ERROR.

    The default value is ACTIVE.

    This parameter is reserved and has been not used.

  • 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", 
            "position": 2, 
            "id": "5ae0e1e7-5f0f-47a1-b39f-5d4c428a1586", 
            "name": "test"
        }
    }

Response Codes

For details, see HTTP Status Codes for Enhanced Load Balancers.