Skip to main content
Eine neuere Version dieses Produkts ist erhältlich.
Die deutsche Sprachversion wurde als Serviceleistung für Sie durch maschinelle Übersetzung erstellt. Bei eventuellen Unstimmigkeiten hat die englische Sprachversion Vorrang.

Alle Benachrichtigungen auflisten

Änderungen vorschlagen
PDFs

GET /accounts/{account_id}/core/v1/notifications

Gibt ein JSON-Array aller übereinstimmenden Ressourcen in der Sammlung zurück. Wenn in der Anfrage einzelne Felder angegeben werden, enthält das JSON-Array die angeforderten Felder für jede übereinstimmende Ressource in der angegebenen Reihenfolge.

Parameter

Name Typ In Erforderlich Beschreibung

Konto-ID

Zeichenkette

Pfad

True

ID der übergeordneten Kontoressource

  • Beispiel: {{.Account}}

Einschließlich

Zeichenkette

Abfrage

Falsch

Gibt an, welche Felder beim Auflisten einer Sammlung zurückgegeben werden sollen.

URL-Beispiele: "include=id", "include=id,name"

OpenAPI-Beispiele: "id"

  • Beispiel: id,summary

Grenze

Zeichenkette

Abfrage

Falsch

Gibt die maximale Anzahl der Ressourcen an, die beim Auflisten einer Sammlung zurückgegeben werden sollen.

URL-Beispiele: "limit=2"

OpenAPI-Beispiele: "2"

  • Beispiel: 4

Filtern

Zeichenkette

Abfrage

Falsch

Gibt an, welche Felder übereinstimmen müssen, um beim Auflisten einer Sammlung eine Ressource zurückzugeben.

Unterstützte Operatoren sind:

  • eq – Gleichheit

  • lt/gt – Kleiner als/Größer als

  • lte/gte – Kleiner oder gleich/Größer oder gleich

URL-Beispiel: "filter=field%20eq%20%27value%27"

OpenAPI-Beispiele: "field eq 'value'"

Orderby

Zeichenkette

Abfrage

Falsch

Gibt die Sortierreihenfolge der Ressourcen beim Auflisten einer Sammlung an.

URL-Beispiele: "orderBy=name", "orderBy=name%20desc"

OpenAPI-Beispiele: "name desc"

überspringen

Zeichenkette

Abfrage

Falsch

Gibt die Anzahl der Ressourcen an, die beim Auflisten einer Sammlung übersprungen werden sollen.

URL-Beispiele: "skip=1"

OpenAPI-Beispiele: "1"

Zählen

Zeichenkette

Abfrage

Falsch

Gibt an, ob die Gesamtzahl der Ressourcen im Metadatenobjekt zurückgegeben werden soll.

URL-Beispiele: "count=true"

OpenAPI-Beispiele: "true"

  • Beispiel: true

fortfahren

Abfrage

Falsch

Gibt das Token an, von dem aus die Auflistung fortgesetzt werden soll.

URL-Beispiele: "continue="

OpenAPI-Beispiele: ""</continue>

Antwort

Status: 200, Returns a JSON array of all matching resources in the collection. If individual fields are specified in the request, the items JSON array will contain the fields requested for each matching resource in the order specified.
Name Typ Erforderlich Beschreibung

Elemente

array[Beliebig aus: "notification_1.3_get_response_body", array[]]

True

Metadaten

"type_astra_metadata_list"

True
Beispielantwort 
{
  "type": "application/astra-notifications",
  "version": "1.3",
  "items": [
    [
      "4f8273ee-883d-47f0-a512-9e27b6285f20",
      "Discovering Applications in Cluster"
    ],
    [
      "1cdd26dc-5eb0-4cf4-a0c1-39a9b83720e1",
      "Application Discovered"
    ],
    [
      "275a8c6f-ebf6-4d10-b671-77d1b8c7c0a6",
      "Application Discovery Failed"
    ],
    [
      "4325f971-ca9c-4a52-bc9a-da6ec62e6bfe",
      "Application Discovered"
    ]
  ],
  "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

True

Titel

Zeichenkette

True

Detail

Zeichenkette

True

Status

Zeichenkette

True

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

True

Titel

Zeichenkette

True

Detail

Zeichenkette

True

Status

Zeichenkette

True

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

True

Titel

Zeichenkette

True

Detail

Zeichenkette

True

Status

Zeichenkette

True

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

True

Titel

Zeichenkette

True

Detail

Zeichenkette

True

Status

Zeichenkette

True

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), angibt, die das Ereignis aufbewahrt wird. 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:

  • "true" – Das Banner kann ausgeblendet werden.

  • "falsch" - Das Banner ist nicht ausblendbar

Typ_Astra_Label

Name Typ Erforderlich Beschreibung

Name

Zeichenkette

True

Wert

Zeichenkette

True

type_astra_metadata

Client- und dienstspezifische Metadaten, die der Ressource zugeordnet sind. Folgende Werte sind definiert:

  • Entspricht dem Astra Metadatenschema

Name Typ Erforderlich Beschreibung

Etiketten

Array["Typ_Astra_Label"]

True

CreationZeitstempel

Zeichenkette

True

Änderungszeitstempel

Zeichenkette

True

Erstellt von

Zeichenkette

True

modifiedBy

Zeichenkette

Falsch

notification_1.3_get_response_body

Name Typ Erforderlich Beschreibung

Typ

Zeichenkette

True

Medientyp der Ressource. Folgende Werte sind definiert:

  • "application/astra-notification"

Version

Zeichenkette

True

Version der Ressource. Folgende Werte sind definiert:

  • "1,0"

  • "1,1"

  • "1,2"

  • "1,3"

id

Zeichenkette

True

Weltweit eindeutiger Bezeichner der Ressource. Folgende Werte sind definiert:

  • Entspricht dem UUIDv4-Schema

Name

Zeichenkette

True

JSON-Zeichenkette mit einem hierarchischen Namen für das Ereignis, der durch Punktnotation (.) dargestellt wird. Folgende Werte sind definiert:

  • Mindestlänge: 3

  • Maximale Länge: 127

  • Definierter regulärer Ausdruck ist: „^[a-z])(\.([a-z])+$“

sequenceCount

Nummer

True

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

True

JSON-Zeichenkette mit der Kurzfassung (weniger als 40 Zeichen) des Ereignisses. Folgende Werte sind definiert:

  • Mindestlänge: 3

  • Maximale Länge: 79

eventTime

Zeichenkette

True

JSON-Zeichenkette mit einem Zeitstempel, der angibt, wann ein Ereignis stattgefunden hat. Folgende Werte sind definiert:

  • Entspricht dem ISO-8601 Datums- und Zeitschema

Quelle

Zeichenkette

True

JSON-Zeichenkette mit dem in Kleinbuchstaben geschriebenen Namen des Dienstes, der ein Ereignis generiert. Folgende Werte sind definiert:

  • Mindestlänge: 1

  • Maximale Länge: 19

  • Der definierte reguläre Ausdruck ist: "^([a-z-])*$"

Ressourcen-ID

Zeichenkette

True

JSON-Zeichenkette mit der Ressourcen-ID eines Ereignisses. Folgende Werte sind definiert:

  • Entspricht dem Astra-Identifikatorschema

zusätzliche Ressourcen-IDs

Array[string]

True

JSON-Array von JSON-Strings, die jeweils eine Ressourcen-ID einer zusätzlichen, dem Ereignis zugeordneten Ressource enthalten. Obwohl das Feld „resourceID“ die primäre Ressource dieses Ereignisses enthält, enthält dieses Feld beliebig viele zusätzliche Ressourcen-IDs, die mit denselben Ereignissen verknüpft werden. Wenn keine zusätzlichen Ressourcen mit dem Ereignis verknüpft sind, ist das Array leer. Folgende Werte sind definiert:

  • Entspricht dem Astra-Identifikatorschema

resourceType

Zeichenkette

True

JSON-Zeichenkette, die den Medientyp der einem Ereignis zugeordneten Ressource enthält. Folgende Werte sind definiert:

  • Mindestlänge: 4

  • Maximale Länge: 79

  • Der definierte reguläre Ausdruck lautet: "^application\/astra-([a-zA-Z])+$"

Korrelations-ID

Zeichenkette

True

JSON-Zeichenkette mit einer UUIDv4-Korrelations-ID, die das Gruppieren zusammengehöriger Ereignisse ermöglicht. Folgende Werte sind definiert:

  • Entspricht dem Astra-Identifikatorschema

severity

Zeichenkette

True

JSON-Zeichenkette mit einem der folgenden Werte, die den Schweregrad eines Ereignisses angeben. Folgende Werte sind definiert:

  • „cleared“ – Zeigt an, dass ein zuvor gemeldetes Ereignis, das einen Zustand beschreibt, nicht mehr aktiv ist. Ein Ereignis mit Schweregrad „cleared“ verwendet dieselbe Zusammenfassung und Korrelations-ID, um die Zuordnung zu ermöglichen.

  • „unbestimmt“ – Gibt an, dass der Schweregrad nicht bestimmt werden kann.

  • „informational“ – Bezeichnet eine Zustandsänderung, die sowohl erwartet als auch normal ist (nicht definiert in X.733).

  • „Warnung“ – Zeigt die Erkennung eines potenziellen oder bevorstehenden, den Dienst beeinträchtigenden Fehlers an, bevor nennenswerte Auswirkungen spürbar werden.

  • „Kritisch“ bedeutet, dass ein betriebsbeeinträchtigender Zustand aufgetreten ist und sofortige Korrekturmaßnahme erforderlich ist. Die Definitionen für „behoben“, „unbestimmt“, „Warnung“ und „kritisch“ basieren auf den Definitionen in Abschnitt 8.1.2.3 von CCITT X.733.

Klasse

Zeichenkette

True

JSON-Zeichenkette mit einem der folgenden Werte, die die Klasse des Ereignisses angeben. Folgende Werte sind definiert:

  • „system“ – Das Ereignis steht im Zusammenhang mit einem internen Ereignis oder einer internen Anfrage.

  • „Benutzer“ – Das Ereignis bezieht sich auf ein vom Benutzer initiiertes Ereignis oder eine Anfrage.

  • „Sicherheit“ – Das Ereignis steht im Zusammenhang mit einem Sicherheitsproblem.

description

Zeichenkette

True

JSON-Zeichenkette mit einem ausführlichen beschreibenden Text zum Ereignis. Folgende Werte sind definiert:

  • Mindestlänge: 3

  • Maximale Länge: 1023

descriptionURL

Zeichenkette

Falsch

JSON-Zeichenkette mit der URL, die eine Schaltfläche im Banner aktiviert und mit einer externen Dokumentation verlinkt. Folgende Werte sind definiert:

  • Mindestlänge: 3

  • Maximale Länge: 4095

correctiveAction

Zeichenkette

Falsch

JSON-Zeichenkette mit einem ausführlichen beschreibenden Text darüber, welche Korrekturmaßnahme als Reaktion auf das Ereignis ergriffen werden sollte. Folgende Werte sind definiert:

  • Mindestlänge: 3

  • Maximale Länge: 1023

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. Folgende Werte sind definiert:

  • Mindestlänge: 3

  • Maximale Länge: 4095

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. Folgende Werte sind definiert:

  • Mindestlänge: 1

  • Maximale Länge: 63

Ziele

Array[string]

Falsch

JSON-Array von JSON-Strings, die jeweils ein zusätzliches Ziel für das Ereignis angeben. Diese ermöglichen es einem Service, Hinweise darüber zu geben, wohin ein Ereignis zusätzlich zum Aktivitätsprotokoll des Activity Service weitergeleitet werden muss. Optional. Folgende Werte sind definiert:

  • „Benachrichtigung“ – Das Ereignis ist als Benachrichtigung gekennzeichnet und wird über den Benachrichtigungen-API-Endpunkt zugänglich sein.

  • "banner" - Die Veranstaltung ist als Banner gekennzeichnet.

  • „support“ – Das Ereignis ist als support-bezogenes Ereignis gekennzeichnet.

resourceURI

Zeichenkette

Falsch

JSON-Zeichenkette mit der URI des Ereignisses. Nur für Ereignisse im Zusammenhang mit API-Operationen enthalten. Folgende Werte sind definiert:

  • Mindestlänge: 3

  • Maximale Länge: 4095

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. Folgende Werte sind definiert:

  • Mindestlänge: 1

  • Maximale Länge: 1023

resourceMethod

Zeichenkette

Falsch

JSON-String mit der aufgerufenen HTTP-Methode. Nur für Ereignisse im Zusammenhang mit API-Operationen enthalten. Folgende Werte sind definiert:

  • "options" - OPTIONS API-Operation

  • "post" - POST-API-Operation

  • "get" - GET-API-Operation

  • "put" - PUT-API-Operation

  • "delete" - DELETE-API-Operation

resourceMethodResult

Zeichenkette

Falsch

JSON-String mit dem Ergebnis der aufgerufenen HTTP-Methode. Wird nur für Ereignisse im Zusammenhang mit API-Operationen bereitgestellt. Folgende Werte sind definiert:

  • Der definierte reguläre Ausdruck lautet: "^[1-5][0-9]{2}$"

Benutzer-ID

Zeichenkette

Falsch

JSON-Zeichenkette mit der Benutzer-ID eines Ereignisses. Nur für Ereignisse enthalten, die mit vom Benutzer initiierten Aktionen verknüpft sind. Folgende Werte sind definiert:

  • Entspricht dem Astra-Identifikatorschema

Konto-ID

Zeichenkette

Falsch

JSON-Zeichenkette mit der Konto-ID eines Ereignisses. Nur für Ereignisse enthalten, die einem Konto zugeordnet sind. Folgende Werte sind definiert:

  • Entspricht dem Astra-Identifikatorschema

Daten

"Daten"

Falsch

JSON-Objekt mit zusätzlichen ereignisspezifischen Informationen.

Metadaten

"type_astra_metadata"

True

Client- und dienstspezifische Metadaten, die der Ressource zugeordnet sind. Folgende Werte sind definiert:

  • Entspricht dem Astra Metadatenschema

type_astra_metadata_list

Name Typ Erforderlich Beschreibung

fortfahren

Zeichenkette

Falsch

Zählen

Nummer

Falsch

Etiketten

Array["Typ_Astra_Label"]

Falsch

CreationZeitstempel

Zeichenkette

Falsch

Änderungszeitstempel

Zeichenkette

Falsch

Erstellt von

Zeichenkette

Falsch

modifiedBy

Zeichenkette

Falsch

invalidParams

Name Typ Erforderlich Beschreibung

Name

Zeichenkette

True

Name des ungültigen Abfrageparameters

Grund

Zeichenkette

True

Grund, warum der Abfrageparameter ungültig ist