Get Listeners

GET 
/backend/api/openstack/lbaas-listeners

Host: https://core.ocplanet.cloud

Access listeners within the Load Balancer as a Service context.

Request

Query Parameters

loadbalancer_id string
page_size string

Responses

200

application/json

Schema

Schema

count integerrequired
next nullstringrequired
objects object[]required
Array [
admin_state_up booleanrequired
id uuidrequired
name stringrequired
operating_status stringrequired
protocol stringrequired
protocol_port integerrequired
provisioning_status stringrequired
]
onePage booleanrequired
pageNo integerrequired
permissions objectrequired
lbaas-listeners.create booleanrequired
lbaas-listeners.destroy booleanrequired
lbaas-listeners.list booleanrequired
lbaas-listeners.retrieve booleanrequired
lbaas-listeners.update booleanrequired
previous nullstringrequired
totalCount integerrequired

Example (from schema)

{
  "count": 0,
  "objects": [
    {
      "admin_state_up": true,
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "operating_status": "string",
      "protocol": "string",
      "protocol_port": 0,
      "provisioning_status": "string"
    }
  ],
  "onePage": true,
  "pageNo": 0,
  "permissions": {
    "lbaas-listeners.create": true,
    "lbaas-listeners.destroy": true,
    "lbaas-listeners.list": true,
    "lbaas-listeners.retrieve": true,
    "lbaas-listeners.update": true
  },
  "totalCount": 0
}

Example

{
  "count": 1,
  "next": null,
  "previous": null,
  "objects": [
    {
      "id": "09c97f5c-0ab4-4b64-ba1f-e1413390d775",
      "name": "listener for new lb",
      "protocol": "HTTP",
      "protocol_port": 80,
      "operating_status": "ONLINE",
      "provisioning_status": "ACTIVE",
      "admin_state_up": true
    }
  ],
  "totalCount": 1,
  "pageNo": 1,
  "onePage": true,
  "permissions": {
    "lbaas-listeners.list": true,
    "lbaas-listeners.retrieve": true,
    "lbaas-listeners.create": true,
    "lbaas-listeners.destroy": true,
    "lbaas-listeners.update": true
  }
}

Loading...