Links erstellen und verwalten
Zuletzt aktualisiert am
Mit Links können Sie Ihren Telemetry Router mit einer STACKIT-Stream-Quelle verbinden. Unterstützte Identifikatoren für Stream-Quellen sind Ordner, Organisationen und Projekte.
Voraussetzungen
Abschnitt betitelt „Voraussetzungen“- Sie haben eine Instanz von STACKIT Telemetry Router. Instanzen erstellen und verwalten
Hierarchie von Telemetrie-Links
Abschnitt betitelt „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
Abschnitt betitelt „Body-Schema“Eigenschaften für Ihren neuen oder bearbeiteten Link wählen
Abschnitt betitelt „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 | eyJhbGci0iJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIi0iIxMjM0NTY30DkwIiwibmFtZSI6IkpvaG4gRG91IiwiaXNTb2NpYWwiOnRydWV9.4pcPyMD09o1PSyXnrXCjTwXyr4BsezdI1AVTmud2fU4 |
telemetryRouterId | Die ID Ihrer Telemetry Router-Instanz | d5b5cdcc-c155-4d66-82ef-4289db8e4557 |
enabled | Ob der Link aktiviert sein soll oder nicht (boolean) | true |
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.
{ [accessToken], [telemetryRouterId], [enabled], [displayName], [description]}Einen Link erstellen
Abschnitt betitelt „Einen Link erstellen“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
Abschnitt betitelt „Ordner-Ebene“| Pfad-Parameter | Bedeutung | Beispiel |
|---|---|---|
| accessToken | Das individuelle Zugriffstoken Ihres Service-Accounts | eyJhbGci0iJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIi0iIxMjM0NTY30DkwIiwibmFtZSI6IkpvaG4gRG91IiwiaXNTb2NpYWwiOnRydWV9.4pcPyMD09o1PSyXnrXCjTwXyr4BsezdI1AVTmud2fU4 |
| folderId | Ihre individuelle Ordner-ID | 16dbfb51-7a75-42d3-a51d-99f87f48cd32 |
| regionId | Die Region, in der sich Ihre Telemetry Router-Instanz befindet | eu01 |
| config | Ein Konfigurationsobjekt. Lesen Sie mehr unter Eigenschaften für Ihren neuen oder bearbeiteten Link wählen |
curl -X PUT \'[https://telemetry-link.api.stackit.cloud/v1beta/folders/](https://telemetry-link.api.stackit.cloud/v1beta/folders/)[folderId]/regions/[regionId]/telemetry-link' \--header 'Authorization: Bearer [accessToken]' \--header 'Content-Type: application/json' \--data-raw '{ [config]}'Organisations-Ebene
Abschnitt betitelt „Organisations-Ebene“| Pfad-Parameter | Bedeutung | Beispiel |
|---|---|---|
| accessToken | Das individuelle Zugriffstoken Ihres Service-Accounts | eyJhbGci0iJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIi0iIxMjM0NTY30DkwIiwibmFtZSI6IkpvaG4gRG91IiwiaXNTb2NpYWwiOnRydWV9.4pcPyMD09o1PSyXnrXCjTwXyr4BsezdI1AVTmud2fU4 |
| organizationId | Ihre individuelle Organisations-ID | 16dbfb51-7a75-42d3-a51d-99f87f48cd32 |
| regionId | Die Region, in der sich Ihre Telemetry Router-Instanz befindet | eu01 |
| config | Ein Konfigurationsobjekt. Lesen Sie mehr unter Eigenschaften für Ihren neuen oder bearbeiteten Link wählen |
curl -X PUT \'[https://telemetry-link.api.stackit.cloud/v1beta/organizations/](https://telemetry-link.api.stackit.cloud/v1beta/organizations/)[organizationId]/regions/[regionId]/telemetry-link' \--header 'Authorization: Bearer [accessToken]' \--header 'Content-Type: application/json' \--data-raw '{ [config]}'Projekt-Ebene
Abschnitt betitelt „Projekt-Ebene“| Pfad-Parameter | Bedeutung | Beispiel |
|---|---|---|
| accessToken | Das individuelle Zugriffstoken Ihres Service-Accounts | eyJhbGci0iJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIi0iIxMjM0NTY30DkwIiwibmFtZSI6IkpvaG4gRG91IiwiaXNTb2NpYWwiOnRydWV9.4pcPyMD09o1PSyXnrXCjTwXyr4BsezdI1AVTmud2fU4 |
| projectId | Ihre individuelle Projekt-ID | 16dbfb51-7a75-42d3-a51d-99f87f48cd32 |
| regionId | Die Region, in der sich Ihre Telemetry Router-Instanz befindet | eu01 |
| config | Ein Konfigurationsobjekt. Lesen Sie mehr unter Eigenschaften für Ihren neuen oder bearbeiteten Link wählen |
curl -X PUT \'[https://telemetry-link.api.stackit.cloud/v1beta/projects/](https://telemetry-link.api.stackit.cloud/v1beta/projects/)[projectId]/regions/[regionId]/telemetry-link' \--header 'Authorization: Bearer [accessToken]' \--header 'Content-Type: application/json' \--data-raw '{ [config]}'Einen Link anzeigen
Abschnitt betitelt „Einen Link anzeigen“Um einen Telemetrie-Link anzuzeigen, müssen Sie den entsprechenden Endpunkt aufrufen. Jede Ebene (Ordner, Organisationen und Projekte) hat ihren eigenen Endpunkt.
Ordner-Ebene
Abschnitt betitelt „Ordner-Ebene“| Pfad-Parameter | Bedeutung | Beispiel |
|---|---|---|
| accessToken | Das individuelle Zugriffstoken Ihres Service-Accounts | eyJhbGci0iJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIi0iIxMjM0NTY30DkwIiwibmFtZSI6IkpvaG4gRG91IiwiaXNTb2NpYWwiOnRydWV9.4pcPyMD09o1PSyXnrXCjTwXyr4BsezdI1AVTmud2fU4 |
| folderId | Ihre individuelle Ordner-ID | 16dbfb51-7a75-42d3-a51d-99f87f48cd32 |
| regionId | Die Region, in der sich Ihre Telemetry Router-Instanz befindet | eu01 |
curl -X GET \'[https://telemetry-link.api.stackit.cloud/v1beta/folders/](https://telemetry-link.api.stackit.cloud/v1beta/folders/)[folderId]/regions/[regionId]/telemetry-link' \--header 'Authorization: Bearer [accessToken]' \--header 'Content-Type: application/json' \Organisations-Ebene
Abschnitt betitelt „Organisations-Ebene“| Pfad-Parameter | Bedeutung | Beispiel |
|---|---|---|
| accessToken | Das individuelle Zugriffstoken Ihres Service-Accounts | eyJhbGci0iJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIi0iIxMjM0NTY30DkwIiwibmFtZSI6IkpvaG4gRG91IiwiaXNTb2NpYWwiOnRydWV9.4pcPyMD09o1PSyXnrXCjTwXyr4BsezdI1AVTmud2fU4 |
| organizationId | Ihre individuelle Organisations-ID | 16dbfb51-7a75-42d3-a51d-99f87f48cd32 |
| regionId | Die Region, in der sich Ihre Telemetry Router-Instanz befindet | eu01 |
curl -X GET \'[https://telemetry-link.api.stackit.cloud/v1beta/organizations/](https://telemetry-link.api.stackit.cloud/v1beta/organizations/)[organizationId]/regions/[regionId]/telemetry-link' \--header 'Authorization: Bearer [accessToken]' \--header 'Content-Type: application/json' \Projekt-Ebene
Abschnitt betitelt „Projekt-Ebene“| Pfad-Parameter | Bedeutung | Beispiel |
|---|---|---|
| accessToken | Das individuelle Zugriffstoken Ihres Service-Accounts | eyJhbGci0iJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIi0iIxMjM0NTY30DkwIiwibmFtZSI6IkpvaG4gRG91IiwiaXNTb2NpYWwiOnRydWV9.4pcPyMD09o1PSyXnrXCjTwXyr4BsezdI1AVTmud2fU4 |
| projectId | Ihre individuelle Projekt-ID | 16dbfb51-7a75-42d3-a51d-99f87f48cd32 |
| regionId | Die Region, in der sich Ihre Telemetry Router-Instanz befindet | eu01 |
curl -X GET \'[https://telemetry-link.api.stackit.cloud/v1beta/projects/](https://telemetry-link.api.stackit.cloud/v1beta/projects/)[projectId]/regions/[regionId]/telemetry-link' \--header 'Authorization: Bearer [accessToken]' \--header 'Content-Type: application/json' \Einen Link bearbeiten
Abschnitt betitelt „Einen Link bearbeiten“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
Abschnitt betitelt „Ordner-Ebene“| Pfad-Parameter | Bedeutung | Beispiel |
|---|---|---|
| accessToken | Das individuelle Zugriffstoken Ihres Service-Accounts | eyJhbGci0iJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIi0iIxMjM0NTY30DkwIiwibmFtZSI6IkpvaG4gRG91IiwiaXNTb2NpYWwiOnRydWV9.4pcPyMD09o1PSyXnrXCjTwXyr4BsezdI1AVTmud2fU4 |
| folderId | Ihre individuelle Ordner-ID | 16dbfb51-7a75-42d3-a51d-99f87f48cd32 |
| regionId | Die Region, in der sich Ihre Telemetry Router-Instanz befindet | eu01 |
| config | Ein Konfigurationsobjekt. Lesen Sie mehr unter Eigenschaften für Ihren neuen oder bearbeiteten Link wählen |
curl -X PATCH \'[https://telemetry-link.api.stackit.cloud/v1beta/folders/](https://telemetry-link.api.stackit.cloud/v1beta/folders/)[folderId]/regions/[regionId]/telemetry-link' \--header 'Authorization: Bearer [accessToken]' \--header 'Content-Type: application/json' \--data-raw '{ [config]}'Organisations-Ebene
Abschnitt betitelt „Organisations-Ebene“| Pfad-Parameter | Bedeutung | Beispiel |
|---|---|---|
| accessToken | Das individuelle Zugriffstoken Ihres Service-Accounts | eyJhbGci0iJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIi0iIxMjM0NTY30DkwIiwibmFtZSI6IkpvaG4gRG91IiwiaXNTb2NpYWwiOnRydWV9.4pcPyMD09o1PSyXnrXCjTwXyr4BsezdI1AVTmud2fU4 |
| organizationId | Ihre individuelle Organisations-ID | 16dbfb51-7a75-42d3-a51d-99f87f48cd32 |
| regionId | Die Region, in der sich Ihre Telemetry Router-Instanz befindet | eu01 |
| config | Ein Konfigurationsobjekt. Lesen Sie mehr unter Eigenschaften für Ihren neuen oder bearbeiteten Link wählen |
curl -X PATCH \'[https://telemetry-link.api.stackit.cloud/v1beta/organizations/](https://telemetry-link.api.stackit.cloud/v1beta/organizations/)[organizationId]/regions/[regionId]/telemetry-link' \--header 'Authorization: Bearer [accessToken]' \--header 'Content-Type: application/json' \--data-raw '{ [config]}'Projekt-Ebene
Abschnitt betitelt „Projekt-Ebene“| Pfad-Parameter | Bedeutung | Beispiel |
|---|---|---|
| accessToken | Das individuelle Zugriffstoken Ihres Service-Accounts | eyJhbGci0iJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIi0iIxMjM0NTY30DkwIiwibmFtZSI6IkpvaG4gRG91IiwiaXNTb2NpYWwiOnRydWV9.4pcPyMD09o1PSyXnrXCjTwXyr4BsezdI1AVTmud2fU4 |
| projectId | Ihre individuelle Projekt-ID | 16dbfb51-7a75-42d3-a51d-99f87f48cd32 |
| regionId | Die Region, in der sich Ihre Telemetry Router-Instanz befindet | eu01 |
| config | Ein Konfigurationsobjekt. Lesen Sie mehr unter Eigenschaften für Ihren neuen oder bearbeiteten Link wählen |
curl -X PATCH \'[https://telemetry-link.api.stackit.cloud/v1beta/projects/](https://telemetry-link.api.stackit.cloud/v1beta/projects/)[projectId]/regions/[regionId]/telemetry-link' \--header 'Authorization: Bearer [accessToken]' \--header 'Content-Type: application/json' \--data-raw '{ [config]}'Einen Link löschen
Abschnitt betitelt „Einen Link löschen“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
Abschnitt betitelt „Ordner-Ebene“| Pfad-Parameter | Bedeutung | Beispiel |
|---|---|---|
| accessToken | Das individuelle Zugriffstoken Ihres Service-Accounts | eyJhbGci0iJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIi0iIxMjM0NTY30DkwIiwibmFtZSI6IkpvaG4gRG91IiwiaXNTb2NpYWwiOnRydWV9.4pcPyMD09o1PSyXnrXCjTwXyr4BsezdI1AVTmud2fU4 |
| folderId | Ihre individuelle Ordner-ID | 16dbfb51-7a75-42d3-a51d-99f87f48cd32 |
| regionId | Die Region, in der sich Ihre Telemetry Router-Instanz befindet | eu01 |
curl -X DELETE \'[https://telemetry-link.api.stackit.cloud/v1beta/folders/](https://telemetry-link.api.stackit.cloud/v1beta/folders/)[folderId]/regions/[regionId]/telemetry-link' \--header 'Authorization: Bearer [accessToken]' \--header 'Content-Type: application/json' \Organisations-Ebene
Abschnitt betitelt „Organisations-Ebene“| Pfad-Parameter | Bedeutung | Beispiel |
|---|---|---|
| accessToken | Das individuelle Zugriffstoken Ihres Service-Accounts | eyJhbGci0iJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIi0iIxMjM0NTY30DkwIiwibmFtZSI6IkpvaG4gRG91IiwiaXNTb2NpYWwiOnRydWV9.4pcPyMD09o1PSyXnrXCjTwXyr4BsezdI1AVTmud2fU4 |
| organizationId | Ihre individuelle Organisations-ID | 16dbfb51-7a75-42d3-a51d-99f87f48cd32 |
| regionId | Die Region, in der sich Ihre Telemetry Router-Instanz befindet | eu01 |
curl -X DELETE \'[https://telemetry-link.api.stackit.cloud/v1beta/organizations/](https://telemetry-link.api.stackit.cloud/v1beta/organizations/)[organizationId]/regions/[regionId]/telemetry-link' \--header 'Authorization: Bearer [accessToken]' \--header 'Content-Type: application/json' \Projekt-Ebene
Abschnitt betitelt „Projekt-Ebene“| Pfad-Parameter | Bedeutung | Beispiel |
|---|---|---|
| accessToken | Das individuelle Zugriffstoken Ihres Service-Accounts | eyJhbGci0iJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIi0iIxMjM0NTY30DkwIiwibmFtZSI6IkpvaG4gRG91IiwiaXNTb2NpYWwiOnRydWV9.4pcPyMD09o1PSyXnrXCjTwXyr4BsezdI1AVTmud2fU4 |
| projectId | Ihre individuelle Projekt-ID | 16dbfb51-7a75-42d3-a51d-99f87f48cd32 |
| regionId | Die Region, in der sich Ihre Telemetry Router-Instanz befindet | eu01 |
curl -X DELETE \'[https://telemetry-link.api.stackit.cloud/v1beta/projects/](https://telemetry-link.api.stackit.cloud/v1beta/projects/)[projectId]/regions/[regionId]/telemetry-link' \--header 'Authorization: Bearer [accessToken]' \--header 'Content-Type: application/json' \