Push-Metriken-API

  • Freigeben Version: Xanadu
  • Aktualisiert 1. August 2024
  • 1 Minute Lesedauer
  • Die Push-Metriken -API stellt Endpunkte bereit, mit denen Sie Rohdaten Operational Intelligence aus einer externen Quelle in die MID-ServerTabelle [] übertragen können.

    Diese API basiert auf clientseitigen Tools, die die Rohdaten aus der externen Quelle an MID-Serverübertragen . Bei der Erweiterung Operative Metriken muss die Option REST-Listener aktivieren aktiviert sein. Weitere Informationen zum Einrichten von MID-Serverfinden Sie unter Erste Schritte mit Operational Intelligence.

    Informationen zu den Authentifizierungsanforderungen finden Sie unter MID-Webservererweiterung konfigurieren.

    Push-Metriken – POST /mid/sa/metrics

    Verschiebt Rohdaten Operational Intelligence aus einer externen Quelle an MID-Server.

    URL-Format

    Standard-URL: /api/mid/sa/metrics

    Unterstützte Anforderungsparameter

    Tabelle : 1. Pfadparameter
    Name Beschreibung
    Keine
    Tabelle : 2. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 3. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    ci2metric_id Liste der Schlüssel-Wert-Paare, die zur Identifizierung des Configuration Item (CI) verwendet werden. Ihre frühere Bezeichnung lautete ci_identifier. Das Skript akzeptiert weiterhin ci_identifier.

    Datentyp: Objekt

    metric_type Name der Metrik

    Datentyp: Zeichenfolge

    Knoten IP-Adresse, FQDN, Name des CI oder Host Im folgenden Beispiel der Name des Linux-Servers, auf dem die Datenträger installiert sind.

    Datentyp: Zeichenfolge

    resource_path Der Pfad der Ressource, für die Metrikdaten gesammelt werden. Im folgenden Beispiel ist C:\ die Ressource, für die Metrikdaten gesammelt werden.

    Datentyp: Zeichenfolge

    Quelle Datenquelle, die den Metriktyp überwacht.

    Datentyp: Zeichenfolge

    timestamp Epochenzeitstempel der Metrik.

    Datentyp: Zahl

    Einheit: Millisekunden

    Wert Metrikwert

    Datentyp: Zahl

    Header

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST API-Header.

    Tabelle : 4. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Content-Type Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json

    Tabelle : 5. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.

    Tabelle : 6. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antworttexts (JSON oder XML)

    Name Beschreibung
    Keine

    cURL-Anforderung

    Der Anforderungstext muss in eckige Klammern eingeschlossen werden, wie in diesem Beispiel gezeigt.

    curl -X POST "https://servicenow-instance/api/mid/sa/metrics"
    -H "Content-Type: application/json"
    -U "username":"password"
    -d "[{
        "metric_type": "Disk C: % Free Space",
        "resource_path": "C:\\",
        "node": "lnux100",
        "value": 50,
        "timestamp": 1473183012000,
        "ci2metric_id": {
            "node": "lnux100"
        },
        "source": "Splunk"
    }]"