Sign in

v1

latestOpenAPI 3.0.12026-07-24110189356.6 KB
stream

Exposes the endpoint to use to produce and consume the data of the layer directly

Exposes the endpoint to use to produce and consume the data of the layer directly, per type of user - consumer or producer. It returns a list of Kafka Broker URL's, client ID (required to enforce quotas), and Group ID prefix.

get/layers/{layerId}/{type}/endpoint

Path parameters

layerIdstring required

The ID of the parent layer for this blob.

type'producer' | 'consumer' required

Identifies whether the properties returned in the response are for a producer or consumer.

Response

OK

kafkaProtocolVersionstring[] required
topicstring required

This field will be deprecated in next API version. Use topics field instead.

topicsstring[] required
clientIdstring required
consumerGroupPrefixstring required

If present, this should be used as the prefix of group.id Kafka Consumer properties.

Example response

{
  "topic": "mycatalogname.mylayername",
  "topics": [
    "mycatalogname.mylayername",
    "mycatalogname.mylayername-_-replicated"
  ],
  "clientId": "my_realm.mycatalogname.mylayername",
  "consumerGroupPrefix": "umkrdWxRx74iKsSBcwiN",
  "bootstrapServers": [
    {
      "hostname": "kafka-0a-sit.streaming.data.api.platform.in.here.com",
      "port": 9093
    }
  ],
  "bootstrapServersInternal": [
    {
      "hostname": "kafka-0a-sit.streaming.data.api.platform.in.here.com",
      "port": 9093
    }
  ]
}