Push-Metriken-API

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 1 Minute Lesedauer
  • Die Push-Metriken Die API stellt Endpunkte bereit, mit denen Sie Rohdaten veröffentlichen können Metrikdaten Daten aus einer externen Quelle an den MID-Server.

    Diese API basiert auf clientseitigen Tools, die die Rohdaten aus der externen Quelle an die übertragen MID-Server. Die Metrikdaten Die Erweiterung muss mit konfiguriert werden Aktivieren Sie DEN REST-Listener Option aktiviert. Weitere Informationen zum Einrichten von MID-Server, Siehe Erste Schritte mit Metric Intelligence .

    Informationen zu Authentifizierungsanforderungen finden Sie unter Konfigurieren Sie die MID-Webservererweiterung .

    Push-Metriken: POST /Mid/sa/metrics

    Veröffentlicht Rohdaten Metrikdaten Daten aus einer externen Quelle an den 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 zum Identifizieren des Konfigurationselements (Configuration Item, CI) verwendet werden sollen. Früher wurde er als bezeichnet ci_identifier. Das Skript wird weiterhin akzeptiert ci_identifier.

    Datentyp: Objekt

    metric_type Name der Metrik

    Datentyp: Zeichenfolge

    Knoten IP-Adresse, FQDN, Name des CI oder Hosts. 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 erfasst werden. Im folgenden Beispiel: C:\ Ist die Ressource, für die Metrikdaten erfasst werden.

    Datentyp: Zeichenfolge

    Quelle Datenquelle, die den Metriktyp überwacht.

    Datentyp: Zeichenfolge

    timestamp Epochenzeitstempel der Metrik.

    Datentyp: Zahl

    Einheit: Millisekunden

    Einheit Einheitentyp, der dem Quellmetriktyp zugeordnet ist.

    Tabelle: Metriktypen des Überwachungssystems [sa_Source_metric_type]

    Datentyp: Zeichenfolge

    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
    Inhaltstyp 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 REST API-HTTP-Antwortcodes .

    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.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Keine

    cURL-Anforderung

    Der Anforderungstext muss von eckigen Klammern umgeben sein, 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"
    }]"