Skip to main content
GET
/
cloud
/
v1
/
lblisteners
/
{project_id}
/
{region_id}
/
{listener_id}
Python
from gcore import Gcore

client = Gcore(
    api_key="My API Key",
)
load_balancer_listener_detail = client.cloud.load_balancers.listeners.get(
    listener_id="00000000-0000-4000-8000-000000000000",
    project_id=1,
    region_id=1,
)
print(load_balancer_listener_detail.id)
{
  "allowed_cidrs": [
    "10.0.0.0/8"
  ],
  "connection_limit": 499999,
  "creator_task_id": "de105b9c-c095-4f1c-9b76-aaa9bc60e32a",
  "id": "43658ea9-54bd-4807-90b1-925921c9a0d1",
  "insert_headers": {},
  "load_balancer_id": "67149a91-739b-42bf-bbd1-cb64f723dad7",
  "name": "lbaas_test_listener",
  "operating_status": "DEGRADED",
  "pool_count": 1,
  "protocol": "TCP",
  "protocol_port": 80,
  "provisioning_status": "ACTIVE",
  "secret_id": "e36200c7-114b-44e6-ba1a-043b2bd53879",
  "sni_secret_id": [
    "e36200c7-114b-44e6-ba1a-043b2bd53879",
    "c5d156ce-0925-4aef-b458-cce46bd346f0"
  ],
  "stats": {
    "active_connections": 0,
    "bytes_in": 34942398609,
    "bytes_out": 304777113641,
    "request_errors": 4,
    "total_connections": 21095970
  },
  "task_id": "<string>",
  "timeout_client_data": 50000,
  "timeout_member_connect": 5000,
  "timeout_member_data": 50000,
  "user_list": [
    {
      "encrypted_password": "$5$isRr.HJ1IrQP38.m$oViu3DJOpUG2ZsjCBtbITV3mqpxxbZfyWJojLPNSPO5",
      "username": "admin"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

​
project_id
integer
required

Project ID

Examples:

1

​
region_id
integer
required

Region ID

Required range: x > 0
Examples:

1

​
listener_id
string<uuid4>
required

Listener ID

Examples:

"00000000-0000-4000-8000-000000000000"

Query Parameters

​
show_stats
boolean
default:false

Show stats

Examples:

true

false

Response

200 - application/json

OK

​
allowed_cidrs
string<ipvanynetwork>[] | null
required

Network CIDRs from which service will be accessible

Examples:
["10.0.0.0/8"]
​
connection_limit
integer
required

Limit of simultaneous connections

Required range: -1 <= x <= 1000000
​
creator_task_id
string<uuid4> | null
required

Task that created this entity

Examples:

"de105b9c-c095-4f1c-9b76-aaa9bc60e32a"

​
id
string<uuid4>
required

Load balancer listener ID

Examples:

"43658ea9-54bd-4807-90b1-925921c9a0d1"

​
insert_headers
object
required

Dictionary of additional header insertion into HTTP headers. Only used with HTTP and TERMINATED_HTTPS protocols.

​
load_balancer_id
string<uuid4> | null
required

Load balancer ID

Examples:

"67149a91-739b-42bf-bbd1-cb64f723dad7"

​
name
string
required

Load balancer listener name

Examples:

"lbaas_test_listener"

​
operating_status
enum<string>
required

Listener operating status

Available options:
DEGRADED,
DRAINING,
ERROR,
NO_MONITOR,
OFFLINE,
ONLINE
​
pool_count
integer | null
required

Number of pools (for UI)

Examples:

1

​
protocol
enum<string>
required

Load balancer protocol

Available options:
HTTP,
HTTPS,
PROMETHEUS,
TCP,
TERMINATED_HTTPS,
UDP
​
protocol_port
integer
required

Protocol port

Required range: 1 <= x <= 65535
Examples:

80

​
provisioning_status
enum<string>
required

Listener lifecycle status

Available options:
ACTIVE,
DELETED,
ERROR,
PENDING_CREATE,
PENDING_DELETE,
PENDING_UPDATE
​
secret_id
string | null
required

ID of the secret where PKCS12 file is stored for TERMINATED_HTTPS or PROMETHEUS load balancer

Examples:

"e36200c7-114b-44e6-ba1a-043b2bd53879"

​
sni_secret_id
string[] | null
required

List of secret's ID containing PKCS12 format certificate/key bundles for TERMINATED_HTTPS or PROMETHEUS listeners

Examples:
[
  "e36200c7-114b-44e6-ba1a-043b2bd53879",
  "c5d156ce-0925-4aef-b458-cce46bd346f0"
]
​
stats
object | null
required

Statistics of the load balancer. It is available only in get functions by a flag.

Examples:
{
  "active_connections": 0,
  "bytes_in": 34942398609,
  "bytes_out": 304777113641,
  "request_errors": 4,
  "total_connections": 21095970
}
​
task_id
string<uuid4> | null
required

The UUID of the active task that currently holds a lock on the resource. This lock prevents concurrent modifications to ensure consistency. If null, the resource is not locked.

​
timeout_client_data
integer | null
required

Frontend client inactivity timeout in milliseconds

Required range: 0 <= x <= 86400000
Examples:

50000

​
timeout_member_connect
integer | null
required

Backend member connection timeout in milliseconds

Required range: 0 <= x <= 86400000
Examples:

5000

​
timeout_member_data
integer | null
required

Backend member inactivity timeout in milliseconds

Required range: 0 <= x <= 86400000
Examples:

50000

​
user_list
UserListItem · object[]
required

Load balancer listener users list

Examples:
[
  {
    "encrypted_password": "$5$isRr.HJ1IrQP38.m$oViu3DJOpUG2ZsjCBtbITV3mqpxxbZfyWJojLPNSPO5",
    "username": "admin"
  }
]