Links erstellen und verwalten

Der Telemetry Link setzt einen bestehenden Telemetry Router voraus. Für jedes Level (Projekt, Ordner, Organisation) kann pro Region ein Telemetry Link angelegt werden. Für die Konfiguration eines Telemetry Links bedarf es sowohl der ID als auch eines Zugriffstokens des Telemetry Routers, welcher verknüpft werden soll. Ein Telemetry Link geht strikt davon aus, dass der konfigurierte Telemetry Router sich in der selben Region befindet.

Voraussetzungen

• Sie haben eine Instanz von STACKIT Telemetry Router. Instanzen erstellen und verwalten

API-Voraussetzungen & Variablen

Um die API-Befehle in dieser Anleitung auszuführen, müssen Sie zuerst die relevanten Pfadparameter als Umgebungsvariablen in Ihrem Terminal exportieren (oder diese direkt in den Befehlen ersetzen). Je nach hierarchischer Ebene Ihres Links benötigen Sie:

• $REGION_ID: Die Region, in der sich Ihre Instanz befindet (z. B. eu01 oder eu02).
• $PROJECT_ID: Ihre STACKIT Projekt-ID (bei der Verwaltung eines Links auf Projektebene).
• $FOLDER_ID: Ihre STACKIT Ordner-ID (bei der Verwaltung eines Links auf Ordnerebene).
• $ORGANIZATION_ID: Ihre STACKIT Organisations-ID (bei der Verwaltung eines Links auf Organisationsebene).

Wenn Sie Hilfe beim Auffinden dieser Identifikatoren benötigen oder erfahren möchten, wie der stackit curl-Wrapper funktioniert, lesen Sie unsere zentrale Anleitung: Interagieren mit der Telemetry Router API.

Eine konzeptionelle Übersicht über die verschiedenen Authentifizierungspfade finden Sie in unserer Authentifizierungsübersicht.

Hierarchie von Telemetrie-Links

Telemetrie-Links sind in drei Ebenen organisiert:

• Ordner: Erfasst alles, was sich auf die Ordner selbst bezieht.
• Organisationen: Erfasst alles, was sich auf die Organisationen selbst bezieht.
• Projekte: Erfasst alles, was sich auf Projekte und alle darin enthaltenen Daten bezieht. Die überwiegende Mehrheit der Daten läuft über diesen Link.

Ein Telemetrie-Link erfasst Daten nur entsprechend seiner zugehörigen Ebene. Es gibt keine Vererbung – um alle verfügbaren Informationen zu erfassen, benötigen Sie mindestens einen Telemetrie-Link für jede Ebene.

Body-Schema

Eigenschaften für Ihren neuen oder bearbeiteten Link wählen

Um einen Telemetrie-Link zu erstellen oder zu bearbeiten, müssen Sie dessen Parameter definieren. Alle Parameter sind Teil eines JSON-Konfigurations-Body-Objekts in dieser Form:

Body-Parameter	Bedeutung	Beispiel
accessToken	Das individuelle Zugriffstoken Ihres Telemetry Router	eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NiIsImtpZCI6ImE1NTZmYWI0MWY2YzQ1MGY3ZDU5YzRmNGVkNWI0NmMxIn0.eyJub3RpY2UiOiJDb25ncmF0dWxhdGlvbnMhIFlvdSBoYXZlIGRlY29kZWQgYSBiZWFyZXIgdG9rZW4gbWVhbnQgZm9yIGRlbW9uc3RyYXRpb24gcHVycG9zZXMuIFdlIGF0IFNUQUNLSVQgZW1waGFzaXplIHNlY3VyaXR5IGFuZCBkYXRhIGludGVncml0eS4gUGxlYXNlIHVzZSB5b3VyIG93biBhY2Nlc3MgdG9rZW4gZm9yIHlvdXIgcmVzb3VyY2VzLiJ9.LPOHfT45JNOpTSh_q6x4pDRVK052QwUwSFU9tLPB6gGrYjf4dTKjWJ-2aRdd2LlWsxO5y0it89VsZpbzVRvI5Q
telemetryRouterId	Die ID Ihrer Telemetry Router-Instanz	d5b5cdcc-c155-4d66-82ef-4289db8e4557
displayName	Ein Name für das Ziel	my-telemetry-link
description	Eine optionale Beschreibung für Ihre Referenz	My new telemetry link

Für die Erstellung sind alle Parameter außer description erforderlich. Für die Bearbeitung sind alle Parameter optional.

In diesem Zusammenhang bezieht sich der Parameter accessToken auf das Zugriffstoken Ihrer Telemetry Router-Instanz und nicht auf das Ihres Service-Accounts.

{
    "accessToken": "<ACCESS_TOKEN>",
    "telemetryRouterId": "<TELEMETRY_ROUTER_ID>",
    "enabled": <ENABLED>,
    "displayName": "<DISPLAY_NAME>",
    "description": "<DESCRIPTION>"
}

Einen Link erstellen

STACKIT API

Um einen Telemetrie-Link zu erstellen, müssen Sie den entsprechenden Endpunkt aufrufen. Jede Ebene (Ordner, Organisationen und Projekte) hat ihren eigenen Endpunkt. Das Body-Schema ist für jede Ebene gleich.

Ordner-Ebene

stackit curl -X PUT \
"https://telemetry-link.api.stackit.cloud/v1/folders/$FOLDER_ID/regions/$REGION_ID/telemetry-link" \
-H "Content-Type: application/json" \
--data '{
    "accessToken": "<ACCESS_TOKEN>",
    "telemetryRouterId": "<TELEMETRY_ROUTER_ID>",
    "enabled": true,
    "displayName": "<DISPLAY_NAME>",
    "description": "<DESCRIPTION>"
}'

Organisations-Ebene

stackit curl -X PUT \
"https://telemetry-link.api.stackit.cloud/v1/organizations/$ORGANIZATION_ID/regions/$REGION_ID/telemetry-link" \
-H "Content-Type: application/json" \
--data '{
    "accessToken": "<ACCESS_TOKEN>",
    "telemetryRouterId": "<TELEMETRY_ROUTER_ID>",
    "enabled": true,
    "displayName": "<DISPLAY_NAME>",
    "description": "<DESCRIPTION>"
}'

Projekt-Ebene

stackit curl -X PUT \
"https://telemetry-link.api.stackit.cloud/v1/projects/$PROJECT_ID/regions/$REGION_ID/telemetry-link" \
-H "Content-Type: application/json" \
--data '{
    "accessToken": "<ACCESS_TOKEN>",
    "telemetryRouterId": "<TELEMETRY_ROUTER_ID>",
    "enabled": true,
    "displayName": "<DISPLAY_NAME>",
    "description": "<DESCRIPTION>"
}'

STACKIT Portal

Sie können auf jeder Ebene nur einen Telemetrie-Link erstellen. Über das STACKIT Portal können Sie darüber hinaus Telemetrie-Links nur auf Projektebene erstellen.

1. Wählen Sie in der Seitenleiste Telemetry Link aus.

2. Wählen Sie Create Telemetry Link aus, um einen neuen Link zu erstellen.

   Falls bereits ein Eintrag vorhanden ist, können Sie keinen zweiten erstellen. Sie müssen entweder den vorhandenen Eintrag löschen, um einen neuen erstellen zu können, oder ihn bearbeiten, wenn Sie geringfügige Änderungen daran vornehmen möchten.

3. Geben Sie im neuen Bereich die erforderlichen Informationen ein.

   Neben dem Namen und einer optionalen Beschreibung werden Sie nach der Telemetry Router ID und ihrem Access token gefragt. Unter Instanzen von Telemetry Router erstellen und verwalten und Access Tokens von Telemetry Router erstellen und verwalten erfahren Sie, wie Sie diese Informationen erhalten.

4. Wählen Sie Create aus.

Einen Link anzeigen

STACKIT API

Um einen Telemetrie-Link anzuzeigen, müssen Sie den entsprechenden Endpunkt aufrufen. Jede Ebene (Ordner, Organisationen und Projekte) hat ihren eigenen Endpunkt.

Ordner-Ebene

stackit curl -X GET \
"https://telemetry-link.api.stackit.cloud/v1/folders/$FOLDER_ID/regions/$REGION_ID/telemetry-link" \
-H "Content-Type: application/json"

Organisations-Ebene

stackit curl -X GET \
"https://telemetry-link.api.stackit.cloud/v1/organizations/$ORGANIZATION_ID/regions/$REGION_ID/telemetry-link" \
-H "Content-Type: application/json"

Projekt-Ebene

stackit curl -X GET \
"https://telemetry-link.api.stackit.cloud/v1/projects/$PROJECT_ID/regions/$REGION_ID/telemetry-link" \
-H "Content-Type: application/json"

STACKIT Portal

1. Wählen Sie in der Seitenleiste Telemetry Link aus.
2. Sie sehen Ihren vorhandenen Link.

Einen Link bearbeiten

STACKIT API

Um einen Telemetrie-Link zu bearbeiten, müssen Sie den entsprechenden Endpunkt aufrufen. Jede Ebene (Ordner, Organisationen und Projekte) hat ihren eigenen Endpunkt. Das Body-Schema ist für jede Ebene gleich.

Ordner-Ebene

stackit curl -X PATCH \
"https://telemetry-link.api.stackit.cloud/v1/folders/$FOLDER_ID/regions/$REGION_ID/telemetry-link" \
-H "Content-Type: application/json" \
--data '<CONFIG_OBJECT>'

Organisations-Ebene

stackit curl -X PATCH \
"https://telemetry-link.api.stackit.cloud/v1/organizations/$ORGANIZATION_ID/regions/$REGION_ID/telemetry-link" \
-H "Content-Type: application/json" \
--data '<CONFIG_OBJECT>'

Projekt-Ebene

stackit curl -X PATCH \
"https://telemetry-link.api.stackit.cloud/v1/projects/$PROJECT_ID/regions/$REGION_ID/telemetry-link" \
-H "Content-Type: application/json" \
--data '<CONFIG_OBJECT>'

STACKIT Portal

1. Wählen Sie in der Seitenleiste Telemetry Link aus.
2. Sie sehen Ihren vorhandenen Link. Wählen Sie ihn aus, um ihn zu bearbeiten.

Einen Link löschen

STACKIT API

Um einen Telemetrie-Link zu löschen, müssen Sie den entsprechenden Endpunkt aufrufen. Jede Ebene (Ordner, Organisationen und Projekte) hat ihren eigenen Endpunkt.

Ordner-Ebene

stackit curl -X DELETE \
"https://telemetry-link.api.stackit.cloud/v1/folders/$FOLDER_ID/regions/$REGION_ID/telemetry-link" \
-H "Content-Type: application/json"

Organisations-Ebene

stackit curl -X DELETE \
"https://telemetry-link.api.stackit.cloud/v1/organizations/$ORGANIZATION_ID/regions/$REGION_ID/telemetry-link" \
-H "Content-Type: application/json"

Projekt-Ebene

stackit curl -X DELETE \
"https://telemetry-link.api.stackit.cloud/v1/projects/$PROJECT_ID/regions/$REGION_ID/telemetry-link" \
-H "Content-Type: application/json"

STACKIT Portal

1. Wählen Sie in der Seitenleiste Telemetry Link aus.
2. Sie sehen Ihren vorhandenen Link. Wählen Sie das Drei-Punkte-Menü aus und wählen Sie Delete.
3. Geben Sie im neuen Bereich den Namen Ihres Telemetrie-Links ein und wählen Sie Delete aus.