• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. Neutron
  5. LBaas
  6. Update listener

Update listener

Function Description

This interface is used to update the listener information.

Interface Format

Method

URI

Description

PUT

/v2.0/lbaas/listeners/{listener_id}

Updates information about a listener.

Restrictions

Only the name and description of a load balancer can be updated.

If the provisioning status of the load balancer associated with a listener is not ACTIVE, the listener cannot be updated.

Only the administrator can specify connection_limit.

Request Parameter

Parameter

Type

Mandatory

Description

listener

Dict

Yes

Specifies the listener. For details, see Table 2.

Response Parameter

Parameter

Type

Mandatory

Description

listener

Dict

Yes

Specifies the listener. For details, see Table 2.

Request Example

PUT  /v2.0/lbaas/listeners/dcaf46f1-037c-4f63-a31f-e0c4c18032c7
{
    "listener": {
        "description": "my listener",
        "name": "listener-jy-test2"
    }
}

Response Example

{
    "listener": {
        "protocol_port": 8000,
        "protocol": "TCP",
        "description": "my listener",
        "default_tls_container_ref": null,
        "admin_state_up": true,
        "loadbalancers": [
            {
                "id": "cfaff0d2-3df3-4730-b2bd-551f454f76c0"
            }
        ],
        "tenant_id": "145483a5107745e9b3d80f956713e6a3",
        "sni_container_refs": [],
        "connection_limit": -1,
        "default_pool_id": null,
        "id": "dcaf46f1-037c-4f63-a31f-e0c4c18032c7",
        "name": "listener-jy-test2"
    }
}

Error Code

See section Return Code Processing.