Standard DevOps Config Exporter

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 5 Minuten Lesedauer

    • Das DevOps Config Exporter-Inhaltspaket enthält eine Reihe von standardmäßigen DevOps Config -Datenexporteuren, die als Eingabe für weitere Bereitstellungs- und Bereitstellungsaktivitäten verwendet werden können.

    Wichtig:
    Ab dem Release Washington DC wird DevOps Config auf den Übergang in den Zustand „Veraltet“ vorbereitet. Es wird ausgeblendet und in neuen Instanzen nicht mehr installiert, aber weiterhin unterstützt. Weitere Informationen finden Sie im Artikel Deprecation Process [KB0867184] (Abkündigungsprozess) in der Now Support Knowledge Base.

    DevOps Config -Exporter ermöglichen anderen Tools, die Daten aus bereitstellbaren Snapshots zu verbrauchen.

    Hinweis:
    Sie können die Standardexporteure nicht ändern. Sie können jedoch eine Kopie des Exporters erstellen und Ihre Kopie anpassen.
    Diese Exporter sind im Exporter-Inhaltspaket DevOps Config enthalten.
    • „returnAllData-now“.
    • „returnAllData_noVars-now“
    • RückgabedatenfürKnotenname-now
    • „returnDataForNodeNames-now“.
    • „returnDataForPath-now“.
    • „returnNodeListForLevel-now“.
    • „returnNodeListForPath-now“.
    • „returnValueForKeyAtNodeName-now“
    • „returnValueForKeyPath-now“
    • „returnValueForUniqueKeyName-now“

    Alle Daten zurückgeben (returnAllData-now)

    Gibt den vollständigen Inhalt des Snapshots ohne Filterung oder Änderungen zurück, einschließlich des var-Systemordners.
    Hinweis:
    Der Exporter schlägt fehl, wenn sich die Anwendung/das bereitstellbare Element nicht im Status „Aktiv“ befindet (gelöscht).
    Argumente
    • appName: Anwendungsname
    • deployableName: Name des bereitstellbaren Elements
    • requestFormat: Angefordertes Format (json/yaml/xml/ini/raw)
    Spezielle Logik
    Keine.
    Fehlerbehandlung
    Keine.

    Alle Daten außer Variablen zurückgeben (returnAllData_noVars-now)

    Gibt alle Konfigurationsdaten für das bereitstellbare Element zurück, mit Ausnahme des Namens und der Variablen des bereitstellbaren Elements.

    Antwort enthält nicht:
    • Ordner„vars“ auf der bereitstellbaren Ebene
    • Ordner„vars“ in jeder der enthaltenen Sammlungen
    • Name des bereitstellbaren Elements auf der Stammebene der Antwort
    Hinweis:
    Dieser Exporter funktioniert nicht für gelöschte Anwendungen/bereitstellbare Elemente.
    Argumente
    Argumente (können in der Befehlszeile angegeben oder interaktiv im Ausführungsmodus eingegeben werden).
    • appName: Anwendungsname
    • deployableName: Name des bereitstellbaren Elements
    • requestFormat: Angefordertes Format (json/yaml/xml/ini/raw)
    Spezielle Logik
    Keine.
    Fehlerbehandlung
    Keine.

    Daten für einen Knotennamen zurückgeben (returnDataforNodeName-now)

    Gibt die Teilmenge der Snapshot-Daten für einen bestimmten Knotennamen zurück, der als Argument angegeben wird. Der Argumentwert muss als Zeichenfolgentext übergeben werden.

    Argumente
    • appName: Anwendungsname
    • deployableName: Name des bereitstellbaren Elements
    • requestFormat: Angefordertes Format (json/yaml/xml/ini/raw)
    • nodeName – Knotenname (Zeichenfolge, in Anführungszeichen)
    • IncludesNodeInOutput – (Zeichenfolge, Standard ist „wahr“)
    Spezielle Logik
    • Wenn nodeName leer ist, werden alle Daten zurückgegeben.
    • Wenn „includeNodeInOutput“ auf „false“ festgelegt ist, werden die Knotendaten ohne den Knotennamen zurückgegeben.
    Fehlerbehandlung
    • Wenn nodeName nicht eindeutig ist, wurden mehrere Instanzen von nodeName gefunden.
    • Wenn der nodeName nicht gefunden wird, wird der Knoten nicht gefunden:<nodeName> .
    • Wenn „includeNodeInOutput“ auf „false“ festgelegt ist und die Knotendaten ein Schlüssel-Wert-Paar sind, wird ein Fehler zurückgegeben.

    Daten für Liste der Knoten zurückgeben (returnDataForNodeNames-now)

    Gibt die vollständigen Daten aus dem Snapshot für eine Liste von Knoten zurück. Identisch mit Rückgabedaten für einen Knotennamen, gibt jedoch ein geschachteltes JSON-Objekt mit Konfigurationsdaten für eine Liste angegebener Knotennamen (einschließlich untergeordneter Knoten) zurück.

    Argumente
    • appName: Anwendungsname
    • deployableName: Name des bereitstellbaren Elements
    • requestFormat: Angefordertes Format (json/yaml/xml/ini/raw)
    • nodeNames: Knotennamen (Zeichenfolge, in Anführungszeichen, durch Kommas getrennt)
    Spezielle Logik
    Wenn nodeNamesList leer ist, werden alle Konfigurationsdaten zurückgegeben.
    Fehlerbehandlung
    Keine.
    Antwortdetails
    {„node1“:{„contentKey“:„contentValue“},„node2“:{ „error“:„nodeName“ nicht gefunden“}}.
    Fehlerbehandlung
    • Falls der nodeName nicht eindeutig ist, gibt der Exporter eine Fehlerantwort zurück, in der angegeben wird, dass für diesen bestimmten nodeName mehrere Instanzen von nodeName gefunden wurden. Andere nodeNames enthalten die Daten
    • Wenn ein nodeName nicht gefunden wird, sollte er eine Fehlermeldung für diesen Knoten enthalten

    Daten für Pfad zurückgeben (returnDataForPath-now)

    Gibt alle Konfigurationsdaten für einen bestimmten Knotenpfad im Snapshot zurück.

    Argumente
    • appName: Anwendungsname
    • deployableName: Name des bereitstellbaren Elements
    • requestFormat: Angefordertes Format (json/yaml/xml/ini/raw)
    • nodePath: Knotenpfad (Zeichenfolge, in Anführungszeichen)
    Spezielle Logik
    Wenn „nodePath“ leer ist, wird der gesamte Inhalt zurückgegeben (ähnlich wie bei allen Konfigurationsdaten).
    Fehlerbehandlung
    Wenn nodePath nicht gefunden wird, wird für den letzten nicht gefundenen Knotennamen angegeben, dass der Pfad nicht gefunden wurde:<nodeName> .

    Rückgabeknotenliste für Ebene (returnNodeListForLevel-now)

    Gibt eine Liste mit Namen von Knoten zurück, die untergeordnete Elemente des Stammknotens auf der angegebenen Ebene (Tiefe) im Snapshot sind. Zum Beispiel ist Ebene 1 ein direktes untergeordnetes Element des Stammknotens, Ebene 2 ein nachfolgendes Element usw.

    Argumente
    • appName: Anwendungsname
    • deployableName: Name des bereitstellbaren Elements
    • requestFormat: Angefordertes Format (json/yaml/xml/ini/raw)
    • ExcludeVarsNode [wahr|falsch]: Schließt den vars-Knoten aus dem Ergebnis aus (wahr oder falsch, Standard ist „wahr“)
    • nodeLevel: Ebene des Knotens (Ganzzahl, Standard ist 0)
    Spezielle Logik
    Wenn keine Ebene angegeben ist, gibt der Exporter den Wert für Ebene 0 zurück (z. B. den Namen des bereitstellbaren Stammknotens).
    Fehlerbehandlung
    Keine.
    Antwortdetails
    [„node1, „node2“, „node3“]

    Rückgabeknotenliste für Pfad (returnNodeListForPath-now)

    Gibt die Liste der Knoten für einen bestimmten Knotenpfad im Snapshot zurück (Unterknoten werden nicht berücksichtigt).

    Argumente
    • appName: Anwendungsname
    • deployableName: Name des bereitstellbaren Elements
    • requestFormat: Angefordertes Format (json/yaml/xml/ini/raw)
    • ExcludeVarsNode [wahr|falsch]: Schließt den vars-Knoten aus dem Ergebnis aus (wahr oder falsch, Standard ist „wahr“)
    • nodePath: Zu verfolgender Pfad mit einer Liste von Knoten, die durch ein pathSeparator-Element getrennt sind (Zeichenfolge, in Anführungszeichen)
    • pathSeparator: Zeichen zum Trennen der Liste von nodePaths (Zeichenfolge, Standard ist „,“)
    Spezielle Logik
    Keine.
    Fehlerbehandlung
    Keine.
    Antwortdetails
    [„node1, „node2“, „node3“]

    Rückgabewert für Schlüssel innerhalb eines Knotens (returnValueForKeyAtNodeName-now)

    gibt den Wert eines bestimmten Schlüssels zurück, der Teil eines Knotens im Snapshot ist. Der Schlüssel kann entweder direkt für den Knoten definiert werden oder niedriger im Datenmodell für eines der untergeordneten Elemente des Knotens definiert werden.

    Der Unterschied zwischen diesem Exporter und dem Exportwert für den eindeutigen Schlüsselnamen besteht darin, dass der Schlüsselname nur innerhalb der Unterstruktur des Knotens eindeutig sein muss.

    Es wird erwartet, dass die Schlüssel-/Knoten-Kombination im Snapshot eindeutig ist. Wenn die Schlüssel-Knoten-Kombination mehrmals gefunden wird, liegt ein Fehler vor.

    Argumente
    • appName: Anwendungsname
    • deployableName: Name des bereitstellbaren Elements
    • requestFormat: Angefordertes Format (json/yaml/xml/ini/raw)
    • keyName: Schlüsselname (Zeichenfolge, in Anführungszeichen)
    • nodeName – Knotenname (Zeichenfolge, in Anführungszeichen)
    Spezielle Logik
    Keine.
    Fehlerbehandlung
    Wenn die Kombination keyName nodeName nicht gefunden wird, wird eine leere Antwort zurückgegeben.

    Rückgabewert für keyPath (returnValueForKeyPath-now)

    Gibt den Wert eines bestimmten Schlüssels in einem bestimmten Pfad zurück.

    Argumente
    • appName: Anwendungsname
    • deployableName: Name des bereitstellbaren Elements
    • requestFormat: Angefordertes Format (json/yaml/xml/ini/raw)
    • keyPath: Liste der Knotennamen mit dem Schlüsselnamen am Ende, getrennt durch ein pathSeparator-Zeichen (Zeichenfolge, in Anführungszeichen)
    • pathSeparator: Zeichen zum Trennen der Liste von Schlüsselpfaden (Zeichenfolge, Standard ist „,“)
    Spezielle Logik
    Keine.
    Fehlerbehandlung
    • Wenn der Schlüsselpfad nicht angegeben ist, wird kein Schlüsselpfad-Argument angegeben.
    • Wenn der Schlüsselpfad nicht gefunden wird, wird der letzte Knotenname nicht gefunden, der Pfad wurde nicht gefunden:<path> /<nodeName> .
    • Wenn der Schlüsselpfad gefunden wird und ein Knoten (kein Schlüssel) ist, ist der angegebene Schlüsselpfad ein Knoten und kein Schlüssel.

    Rückgabewert für eindeutigen Schlüsselnamen (returnValueForUniqueKeyName-now)

    Gibt den Wert eines bestimmten Schlüssels basierend auf seinem Namen im Snapshot zurück. Im Gegensatz zum Exportwert für den Schlüssel innerhalb eines Knotenswird erwartet, dass der Schlüssel im gesamten Snapshot-Datenmodell eindeutig ist. Mehrere Schlüssel werden unterstützt.
    Hinweis:
    Die Formate XML und INI werden für diesen Exporter nicht unterstützt.
    Argumente
    • appName: Anwendungsname
    • deployableName: Name des bereitstellbaren Elements
    • requestFormat: Angefordertes Format (json/yaml/raw)
    • keyName: Schlüsselname (Daten-Array)
    Spezielle Logik
    Wenn der Schlüssel im Snapshot mehrmals vorhanden ist, gibt der Exporter den ersten gefundenen Wert zurück (gibt Fehler zurück).
    Fehlerbehandlung
    • Wenn keyName nicht angegeben wird, wird kein keyName-Argument angegeben.
    • Wenn der Schlüssel nicht gefunden wird, Schlüssel nicht gefunden:<keyName> .