HEhere
stream

Expose the endpoint to consume the data of the layer directly

Returns a list of Kafka Broker URL's, client ID (required to enforce quotas), and Group ID prefix. Type is set to a consumer.

get/layers/{layerId}/endpoint

Request

  • Base URL
    https://use.apilookup.for.a.base.url
  • URL
    https://use.apilookup.for.a.base.url/layers/{layerId}/endpoint
  • Auth
    HTTP bearer

Path parameters

layerIdstring required

The ID of the parent layer for this blob.

Query parameters

internalboolean

Specifies whether internal bootstrap servers will be returned in the response.

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
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.