Get a Virtual Cluster

Returns information about a specific virtual cluster associated with the Event Gateway.

get

Path Parameters

gatewayIdstring(uuid)required

The UUID of your Gateway.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

virtualClusterIdstring(uuid)required

The ID of the Virtual Cluster.

Response

application/json

A single virtual cluster object.

VirtualCluster

A representation of a Kafka cluster that maps to a backend cluster.

* Additional properties are NOT allowed.
idstring(uuid)required

The unique identifier of the virtual cluster.

descriptionstring

A human-readable description of the virtual cluster.

Default:

<= 512 characters

destinationobjectrequired

The backend cluster associated with the virtual cluster.

* Additional properties are NOT allowed.
Show Child Parameters
authenticationOne Of
arrayrequired

How to handle authentication from clients.

It tries to authenticate with every rule sequentially one by one.
It succeeds on the first match, and fails if no rule matches.

>= 1 items

VirtualClusterAuthenticationAnonymousobject
Show Child Parameters
namespaceobject

Namespace allows to implement multitenancy using a single backend cluster.
It allows to either hide or enforce a static prefix on resources (topics, consumer group IDs, transaction IDs).

Show Child Parameters
namestringrequired

The name of the virtual cluster.

>= 1 characters<= 255 characters

dns_labelstringrequired

The DNS label used in the bootstrap server URL to identify the virtual cluster when using SNI routing.
The format follows the RFC1035: 1-63 chars, lowercase alphanumeric or ‘-’, must start and end with an alphanumeric character.

Match pattern:^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

>= 1 characters<= 63 characters

Example:vcluster-1

acl_modestringrequired

Configures whether or not ACL policies are enforced on the gateway.

  • enforce_on_gateway means the gateway enforces its own ACL policies for this virtual cluster
    and does not forward ACL-related commands to the backend cluster.
    Note that if there are no ACL policies configured, all access is denied.
  • passthrough tells the gateway to forward all ACL-related commands.

Allowed values:enforce_on_gatewaypassthrough

labelsobject

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

get/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}
 
application/json

Update Virtual Cluster

Updates an existing virtual cluster associated with the specified Event Gateway.

put

Path Parameters

gatewayIdstring(uuid)required

The UUID of your Gateway.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

virtualClusterIdstring(uuid)required

The ID of the Virtual Cluster.

Body

application/json

The request schema for updating a virtual cluster.

* Additional properties are NOT allowed.
namestringrequired

The name of the virtual cluster.

>= 1 characters<= 255 characters

descriptionstring

A human-readable description of the virtual cluster.

Default:

<= 512 characters

destinationAny Of
required

The backend cluster associated with the virtual cluster.

Either id or name must be provided. Following changes to the backend cluster name won’t affect the
reference, as the system will create the entities relationship by id.

BackendClusterReferenceByIdobject
Show Child Parameters
authenticationOne Of
arrayrequired

How to handle authentication from clients.

It tries to authenticate with every rule sequentially one by one.
It succeeds on the first match, and fails if no rule matches.

>= 1 items

VirtualClusterAuthenticationAnonymousobject
Show Child Parameters
namespaceobject

Namespace allows to implement multitenancy using a single backend cluster.
It allows to either hide or enforce a static prefix on resources (topics, consumer group IDs, transaction IDs).

Show Child Parameters
acl_modestringrequired

Configures whether or not ACL policies are enforced on the gateway.

  • enforce_on_gateway means the gateway enforces its own ACL policies for this virtual cluster
    and does not forward ACL-related commands to the backend cluster.
    Note that if there are no ACL policies configured, all access is denied.
  • passthrough tells the gateway to forward all ACL-related commands.

Allowed values:enforce_on_gatewaypassthrough

dns_labelstringrequired

The DNS label used in the bootstrap server URL to identify the virtual cluster when using SNI routing.
The format follows the RFC1035: 1-63 chars, lowercase alphanumeric or ‘-’, must start and end with an alphanumeric character.

Match pattern:^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

>= 1 characters<= 63 characters

Example:vcluster-1

labelsobject

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

Response

application/json

Updated virtual cluster object.

VirtualCluster

A representation of a Kafka cluster that maps to a backend cluster.

* Additional properties are NOT allowed.
idstring(uuid)required

The unique identifier of the virtual cluster.

descriptionstring

A human-readable description of the virtual cluster.

Default:

<= 512 characters

destinationobjectrequired

The backend cluster associated with the virtual cluster.

* Additional properties are NOT allowed.
Show Child Parameters
authenticationOne Of
arrayrequired

How to handle authentication from clients.

It tries to authenticate with every rule sequentially one by one.
It succeeds on the first match, and fails if no rule matches.

>= 1 items

VirtualClusterAuthenticationAnonymousobject
Show Child Parameters
namespaceobject

Namespace allows to implement multitenancy using a single backend cluster.
It allows to either hide or enforce a static prefix on resources (topics, consumer group IDs, transaction IDs).

Show Child Parameters
namestringrequired

The name of the virtual cluster.

>= 1 characters<= 255 characters

dns_labelstringrequired

The DNS label used in the bootstrap server URL to identify the virtual cluster when using SNI routing.
The format follows the RFC1035: 1-63 chars, lowercase alphanumeric or ‘-’, must start and end with an alphanumeric character.

Match pattern:^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

>= 1 characters<= 63 characters

Example:vcluster-1

acl_modestringrequired

Configures whether or not ACL policies are enforced on the gateway.

  • enforce_on_gateway means the gateway enforces its own ACL policies for this virtual cluster
    and does not forward ACL-related commands to the backend cluster.
    Note that if there are no ACL policies configured, all access is denied.
  • passthrough tells the gateway to forward all ACL-related commands.

Allowed values:enforce_on_gatewaypassthrough

labelsobject

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

put/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}

Body

{ "name": "name", "destination": { "id": "id" }, "authentication": [ { "type": "anonymous" } ], "acl_mode": "enforce_on_gateway", "dns_label": "vcluster-1" }
 
application/json

Delete Virtual Cluster

Deletes a specific virtual cluster associated with the Event Gateway.

delete

Path Parameters

gatewayIdstring(uuid)required

The UUID of your Gateway.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

virtualClusterIdstring(uuid)required

The ID of the Virtual Cluster.

Response

No Content

delete/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}
 

Event Gateway Listeners

A listener represents hostname-port or IP-port combinations that connect to TCP sockets. Listeners need at least as many ports as backend brokers if you use port mapping in a Forward to Virtual Cluster policy. For SNI routing, you can route all brokers using a listener with only one port. Ports can be expressed as a single port or range. Addresses can be IPv4, IPv6, or hostnames.

A listener can have policies that enforce TLS certificates and perform SNI routing. The listener runs at Layer 4 of the network stack. In Kong Event Gateway, listeners first take in the connection and then route the TCP connection to a virtual cluster based on conditions defined in listener policies.

List Event Gateway Listeners

Returns a list of listeners associated with the specified Event Gateway.

get

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[after]string

Request the next page of data, starting with the item after this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

filterobject

Filter listeners returned in the response.

Show Child Parameters

Path Parameters

gatewayIdstring(uuid)required

The UUID of your Gateway.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Response

application/json

A paginated list response for a collection of Event Gateway listeners.

metaobject

Pagination metadata.

Show Child Parameters
dataarray[object]

Listeners are used to expose virtual clusters to clients.

* Additional properties are NOT allowed.
Show Child Parameters
get/event-gateways/{gatewayId}/listeners
 
application/json