Create Listeners for Load Balancer

POST 
https://core-pl.ocplanet.cloud/backend/api/openstack/lbaas-listeners

Host: https://core.ocplanet.cloud

You may not have services or there may not be funds on your balance to complete this operation.

Request

application/json

Body

listener_details objectrequired
admin_state_up booleanrequired
connection_limit integerrequired
description stringrequired
name stringrequired
protocol stringrequired
protocol_port integerrequired
timeout_client_data integerrequired
timeout_member_connect integerrequired
timeout_member_data integerrequired
timeout_tcp_inspect integerrequired
x_forwarded_for booleanrequired
x_forwarded_port booleanrequired
x_forwarded_proto booleanrequired
x_ssl_client_cn booleanrequired
x_ssl_client_dn booleanrequired
x_ssl_client_has_cert booleanrequired
x_ssl_client_not_after booleanrequired
x_ssl_client_not_before booleanrequired
x_ssl_client_sha1 booleanrequired
x_ssl_client_verify booleanrequired
x_ssl_issuer booleanrequired
loadbalancer_id stringrequired
monitor_details objectrequired
admin_state_up booleanrequired
delay integerrequired
expected_codes stringrequired
http_method stringrequired
max_retries integerrequired
max_retries_down integerrequired
name stringrequired
timeout integerrequired
type stringrequired
url_path stringrequired
pool_details objectrequired
admin_state_up booleanrequired
description stringrequired
lb_algorithm stringrequired
name stringrequired
session_persistence objectrequired
type stringrequired
pool_members object[]required
Array [
address string
protocol_port string
subnet_id string
weight string
]

Responses

400

application/json

Schema

Schema

detail stringrequired

Example (from schema)

{
  "detail": "string"
}

Example

{
  "detail": "Unable to create listener, please contact support"
}

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: Use 'OpenAPIToken {token}' as the value

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X POST 'https://core-pl.ocplanet.cloud/backend/api/openstack/lbaas-listeners' \
-H 'Content-Type: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "listener_details": {
    "admin_state_up": true,
    "connection_limit": 0,
    "description": "string",
    "name": "string",
    "protocol": "string",
    "protocol_port": 0,
    "timeout_client_data": 0,
    "timeout_member_connect": 0,
    "timeout_member_data": 0,
    "timeout_tcp_inspect": 0,
    "x_forwarded_for": true,
    "x_forwarded_port": true,
    "x_forwarded_proto": true,
    "x_ssl_client_cn": true,
    "x_ssl_client_dn": true,
    "x_ssl_client_has_cert": true,
    "x_ssl_client_not_after": true,
    "x_ssl_client_not_before": true,
    "x_ssl_client_sha1": true,
    "x_ssl_client_verify": true,
    "x_ssl_issuer": true
  },
  "loadbalancer_id": "string",
  "monitor_details": {
    "admin_state_up": true,
    "delay": 0,
    "expected_codes": "string",
    "http_method": "string",
    "max_retries": 0,
    "max_retries_down": 0,
    "name": "string",
    "timeout": 0,
    "type": "string",
    "url_path": "string"
  },
  "pool_details": {
    "admin_state_up": true,
    "description": "string",
    "lb_algorithm": "string",
    "name": "string",
    "session_persistence": {
      "type": "string"
    }
  },
  "pool_members": [
    {
      "address": "string",
      "protocol_port": "string",
      "subnet_id": "string",
      "weight": "string"
    }
  ]
}'

Request Collapse all

Base URL

https://core-pl.ocplanet.cloud

Auth

apikey header authorization

Body

• Example (from schema)
• Example

{
  "listener_details": {
    "admin_state_up": true,
    "connection_limit": 0,
    "description": "string",
    "name": "string",
    "protocol": "string",
    "protocol_port": 0,
    "timeout_client_data": 0,
    "timeout_member_connect": 0,
    "timeout_member_data": 0,
    "timeout_tcp_inspect": 0,
    "x_forwarded_for": true,
    "x_forwarded_port": true,
    "x_forwarded_proto": true,
    "x_ssl_client_cn": true,
    "x_ssl_client_dn": true,
    "x_ssl_client_has_cert": true,
    "x_ssl_client_not_after": true,
    "x_ssl_client_not_before": true,
    "x_ssl_client_sha1": true,
    "x_ssl_client_verify": true,
    "x_ssl_issuer": true
  },
  "loadbalancer_id": "string",
  "monitor_details": {
    "admin_state_up": true,
    "delay": 0,
    "expected_codes": "string",
    "http_method": "string",
    "max_retries": 0,
    "max_retries_down": 0,
    "name": "string",
    "timeout": 0,
    "type": "string",
    "url_path": "string"
  },
  "pool_details": {
    "admin_state_up": true,
    "description": "string",
    "lb_algorithm": "string",
    "name": "string",
    "session_persistence": {
      "type": "string"
    }
  },
  "pool_members": [
    {
      "address": "string",
      "protocol_port": "string",
      "subnet_id": "string",
      "weight": "string"
    }
  ]
}

ResponseClear

Click the Send API Request button above and see the response here!