Ein Ereignis abrufen
GET /accounts/{account_id}/core/v1/events/{event_id}
Gibt die gespeicherte Event-API-Ressource im JSON-Antworttext zurück.
Parameter
| Name | Typ | In | Erforderlich | Beschreibung |
|---|---|---|---|---|
Konto-ID |
Zeichenkette |
Pfad |
Wahr |
ID der übergeordneten Kontoressource
|
Ereignis-ID |
Zeichenkette |
Pfad |
Wahr |
ID der aufzulistenden Ereignissammlung |
Antwort
Status: 200, Returns the stored Event API resource in the JSON response body.
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
Wahr |
Medientyp der Ressource. Definierte Werte sind:
|
Version |
Zeichenkette |
Wahr |
Version der Ressource. Definierte Werte sind:
|
id |
Zeichenkette |
Wahr |
Weltweit eindeutiger Bezeichner der Ressource. Definierte Werte sind:
|
Name |
Zeichenkette |
Wahr |
JSON-Zeichenkette mit einem hierarchischen Namen für das Ereignis, der durch Punktnotation (.) dargestellt wird. Definierte Werte sind:
|
sequenceCount |
Nummer |
Wahr |
Eine JSON-Zahl, die einen Sequenzzähler enthält. Die Zahl wird vom System jedes Mal erhöht, wenn ein neues Ereignis empfangen wird. |
Zusammenfassung |
Zeichenkette |
Wahr |
JSON-Zeichenkette mit der Kurzfassung (weniger als 40 Zeichen) des Ereignisses. Folgende Werte sind definiert:
|
eventTime |
Zeichenkette |
Wahr |
JSON-Zeichenkette mit einem Zeitstempel, der angibt, wann ein Ereignis stattgefunden hat. Definierte Werte sind:
|
Quelle |
Zeichenkette |
Wahr |
JSON-Zeichenkette mit dem in Kleinbuchstaben geschriebenen Namen des Dienstes, der ein Ereignis generiert. Folgende Werte sind definiert:
|
Ressourcen-ID |
Zeichenkette |
Wahr |
JSON-Zeichenkette mit der Ressourcen-ID eines Ereignisses. Folgende Werte sind definiert:
|
zusätzliche Ressourcen-IDs |
Array[string] |
Wahr |
JSON-Array von JSON-Strings, die jeweils eine Ressourcen-ID einer zusätzlichen, dem Ereignis zugeordneten Ressource enthalten. Während das Feld „resourceID“ die primäre Ressource dieses Ereignisses enthält, enthält dieses Feld beliebig viele zusätzliche Ressourcen-IDs, die demselben Ereignis zugeordnet werden. Wenn keine zusätzlichen Ressourcen mit dem Ereignis verknüpft sind, ist das Array leer. Definierte Werte sind:
|
resourceType |
Zeichenkette |
Wahr |
JSON-Zeichenkette, die den Medientyp der einem Ereignis zugeordneten Ressource enthält. Definierte Werte sind:
|
Korrelations-ID |
Zeichenkette |
Wahr |
JSON-Zeichenkette mit einer UUIDv4-Korrelations-ID, die das Gruppieren zusammengehöriger Ereignisse ermöglicht. Definierte Werte sind:
|
severity |
Zeichenkette |
Wahr |
JSON-Zeichenkette mit einem der folgenden Werte, die den Schweregrad eines Ereignisses angeben. Definierte Werte sind:
|
Klasse |
Zeichenkette |
Wahr |
JSON-Zeichenkette mit einem der folgenden Werte, die die Klasse des Ereignisses angeben. Definierte Werte sind:
|
description |
Zeichenkette |
Wahr |
JSON-Zeichenkette mit einem ausführlichen beschreibenden Text zum Ereignis. Definierte Werte sind:
|
descriptionURL |
Zeichenkette |
Falsch |
JSON-Zeichenkette mit der URL, die eine Schaltfläche im Banner aktiviert und mit einer externen Dokumentation verlinkt. Definierte Werte sind:
|
correctiveAction |
Zeichenkette |
Falsch |
JSON-Zeichenkette mit einem ausführlichen beschreibenden Text darüber, welche Korrekturmaßnahme als Reaktion auf das Ereignis ergriffen werden muss. Folgende Werte sind definiert:
|
Korrekturmaßnahme-URL |
Zeichenkette |
Falsch |
JSON-String mit der URL, die eine Schaltfläche im Banner mit einer Seite innerhalb der Benutzeroberfläche verknüpft, um das Problem zu beheben. Definierte Werte sind:
|
Sichtbarkeit |
Array[string] |
Falsch |
JSON-Array von JSON-Strings, die jeweils eine RBAC-Rolle angeben, die berechtigt ist, das Ereignis anzuzeigen. Rollen werden mit ODER verknüpft. Optional. Falls weggelassen, kann ein Benutzer mit jeder RBAC-Rolle das Ereignis anzeigen. Definierte Werte sind:
|
Ziele |
Array[string] |
Falsch |
JSON-Array von JSON-Strings, die jeweils ein zusätzliches Ziel für das Ereignis angeben. Diese Strings ermöglichen es einem Service, Hinweise darüber zu geben, wohin ein Ereignis zusätzlich zum Aktivitätsprotokoll weitergeleitet werden soll. Optional. Definierte Werte sind:
|
resourceURI |
Zeichenkette |
Falsch |
JSON-Zeichenkette mit der URI des Ereignisses. Nur für Ereignisse im Zusammenhang mit API-Operationen enthalten. Definierte Werte sind:
|
resourceCollectionURL |
Array[string] |
Falsch |
JSON-Array von JSON-Zeichenketten, die jeweils die vollständig expandierte Zugriffs-URL der mit dem Ereignis verknüpften Ressource angeben. Definierte Werte sind:
|
resourceMethod |
Zeichenkette |
Falsch |
JSON-String mit der aufgerufenen HTTP-Methode. Wird nur für Ereignisse im Zusammenhang mit API-Operationen bereitgestellt. Folgende Werte sind definiert:
|
resourceMethodResult |
Zeichenkette |
Falsch |
JSON-String mit dem Ergebnis der aufgerufenen HTTP-Methode. Wird nur für Ereignisse im Zusammenhang mit API-Operationen bereitgestellt. Definierte Werte sind:
|
Benutzer-ID |
Zeichenkette |
Falsch |
JSON-Zeichenkette mit der Benutzer-ID, die mit einem Ereignis verknüpft ist. Nur für Ereignisse enthalten, die mit benutzerinitiierten Aktionen verbunden sind. Definierte Werte sind:
|
Konto-ID |
Zeichenkette |
Falsch |
JSON-Zeichenkette mit der Konto-ID, die mit einem Ereignis verknüpft ist. Nur für Ereignisse enthalten, die mit einem Konto verknüpft sind. Definierte Werte sind:
|
Daten |
Falsch |
JSON-Objekt mit zusätzlichen ereignisspezifischen Informationen. |
|
Metadaten |
Wahr |
Client- und dienstspezifische Metadaten, die der Ressource zugeordnet sind. Definierte Werte sind:
|
Beispielantwort
{
"type": "application/astra-event",
"version": "1.4",
"id": "c32df10b-8cfb-5a1e-9510-2a262b476009",
"name": "astra.app.discovery.failed",
"sequenceCount": 48923,
"summary": "Application Discovery Failed",
"eventTime": "2020-08-06T12:24:51.846543Z",
"source": "composite-compute",
"resourceID": "f670bf11-8850-44bd-b330-815af6186a06",
"additionalResourceIDs": [
"84dfee99-b7b2-46d2-9021-0a1a9a5df1d6",
"abb32003-07b9-49b1-9938-1cf6d2f33566"
],
"resourceType": "application/astra-app",
"correlationID": "3c603442-cfca-4af9-9f1b-40dde5c7a806",
"severity": "warning",
"class": "user",
"description": "Discovering the application 'mysql' was unsuccessful. K8s error 442. Application marked in state 'error'.",
"resourceURI": "/accounts/fdaa655c-15ab-4d34-aa61-1e9098e67be0/topology/v1/managedClusters/dfd9de2d-6f0b-437b-a737-c8f7f176cd14/apps/f670bf11-8850-44bd-b330-815af6186a06",
"resourceCollectionURL": [
"https://www.astra.io/accounts/fdaa655c-15ab-4d34-aa61-1e9098e67be0/topology/v1/clouds/0df3f1a0-7203-4c12-aabf-a7bee6302671/clusters/dfd9de2d-6f0b-437b-a737-c8f7f176cd14/namespaces/f8b58091-4b9c-4c64-9b40-018dbaf7c5de/apps/f670bf11-8850-44bd-b330-815af6186a06",
"https://www.astra.io/accounts/fdaa655c-15ab-4d34-aa61-1e9098e67be0/topology/v1/clouds/0df3f1a0-7203-4c12-aabf-a7bee6302671/clusters/dfd9de2d-6f0b-437b-a737-c8f7f176cd14/namespaces/923708f8-0435-45b5-8c00-fbdef3ffaf25/apps/f670bf11-8850-44bd-b330-815af6186a06"
],
"userID": "abda967f-cd2c-4237-908e-99266648c553",
"accountID": "f126d214-bccf-4558-86b4-2137a41e734f",
"metadata": {
"labels": [],
"creationTimestamp": "2022-10-06T20:58:16.305662Z",
"modificationTimestamp": "2022-10-06T20:58:16.305662Z",
"createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269"
}
}
Antwort
Status: 401, Unauthorized
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
Wahr |
|
Titel |
Zeichenkette |
Wahr |
|
Detail |
Zeichenkette |
Wahr |
|
Status |
Zeichenkette |
Wahr |
|
Korrelations-ID |
Zeichenkette |
Falsch |
Beispielantwort
{
"type": "https://astra.netapp.io/problems/3",
"title": "Missing bearer token",
"detail": "The request is missing the required bearer token.",
"status": "401"
}
Antwort
Status: 400, Bad request
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
Wahr |
|
Titel |
Zeichenkette |
Wahr |
|
Detail |
Zeichenkette |
Wahr |
|
Status |
Zeichenkette |
Wahr |
|
Korrelations-ID |
Zeichenkette |
Falsch |
|
invalidParams |
Array["invalidParams"] |
Falsch |
Liste ungültiger Abfrageparameter |
Beispielantwort
{
"type": "https://astra.netapp.io/problems/5",
"title": "Invalid query parameters",
"detail": "The supplied query parameters are invalid.",
"status": "400"
}
Antwort
Status: 403, Forbidden
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
Wahr |
|
Titel |
Zeichenkette |
Wahr |
|
Detail |
Zeichenkette |
Wahr |
|
Status |
Zeichenkette |
Wahr |
|
Korrelations-ID |
Zeichenkette |
Falsch |
Beispielantwort
{
"type": "https://astra.netapp.io/problems/11",
"title": "Operation not permitted",
"detail": "The requested operation isn't permitted.",
"status": "403"
}
Fehler
Status: 404, Not found
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
Wahr |
|
Titel |
Zeichenkette |
Wahr |
|
Detail |
Zeichenkette |
Wahr |
|
Status |
Zeichenkette |
Wahr |
|
Korrelations-ID |
Zeichenkette |
Falsch |
Beispiel-Fehlermeldung
{
"type": "https://astra.netapp.io/problems/2",
"title": "Collection not found",
"detail": "The collection specified in the request URI wasn't found.",
"status": "404"
}
Definitionen
Siehe Definitionen
Daten
JSON-Objekt mit zusätzlichen ereignisspezifischen Informationen.
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
ttl |
Nummer |
Falsch |
JSON-Zahl, die die Anzahl der Sekunden (seit dem eventTime), die das Ereignis aufbewahrt wird, angibt. Dieses Feld ist nur enthalten, wenn ein Ereignis nach der angegebenen Anzahl von Sekunden automatisch gelöscht wird. Beim Löschen werden, falls das Ereignis ein Benachrichtigungsziel hat, auch alle zugehörigen Benachrichtigungen gelöscht. Beim Löschen wird, falls das Ereignis ein Bannerziel hat, auch das Banner entfernt. Das Fehlen dieses Feldes (oder ein Wert von „0“) bedeutet, dass ein Ereignis nicht automatisch gelöscht wird. |
isAcknowledgeable |
Zeichenkette |
Falsch |
JSON-Zeichenkette, die angibt, ob das Banner ausgeblendet werden kann. Folgende Werte sind definiert:
|
Typ_Astra_Label
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Name |
Zeichenkette |
Wahr |
|
Wert |
Zeichenkette |
Wahr |
type_astra_metadata
Client- und dienstspezifische Metadaten, die der Ressource zugeordnet sind. Definierte Werte sind:
-
Entspricht dem Astra Metadatenschema
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Etiketten |
Array["Typ_Astra_Label"] |
Wahr |
|
CreationZeitstempel |
Zeichenkette |
Wahr |
|
Änderungszeitstempel |
Zeichenkette |
Wahr |
|
Erstellt von |
Zeichenkette |
Wahr |
|
modifiedBy |
Zeichenkette |
Falsch |
invalidParams
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Name |
Zeichenkette |
Wahr |
Name des ungültigen Abfrageparameters |
Grund |
Zeichenkette |
Wahr |
Grund, warum der Abfrageparameter ungültig ist |