MetricBase-Zeitreihen-API
Die MetricBase-Zeitreihe Die API stellt Endpunkte bereit, in die Daten eingefügt, Informationen abgerufen und Transformationen für ausgeführt werden können MetricBase Datenbank.
Diese API kann nur verwendet werden, wenn MetricBase Plugin (com.snc.clotho) ist installiert und aktiviert.
Rolle, die zum Schreiben in diese API erforderlich ist: Clotho_Rest_put.
Die Beispiele in diesem Abschnitt wurden mithilfe von Daten im MetricBase-Plugin (com.snc.clotho) erstellt.
MetricBase-Zeitreihe – GET /now/clotho/table/{table}/{subject}/{metric}
Ruft die angegebenen Zeitreihendaten von ab MetricBase Datenbank.
URL-Format
Versionierte URL: /api/now/{api_Version}/clotho/table/{table}/{subject}/{metric}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | |
| Metrik | Name der Spalte in der Tabelle, die in identifiziert wurde subjectParameter, der als Metrik verwendet werden soll. Datentyp: Zeichenfolge |
| subject | SYS_ID des GlideRecord, der dieser Serie zugeordnet ist. Datentyp: Zeichenfolge |
| Tabelle | Name der Tabelle, die den GlideRecord enthält, der dieser Serie zugeordnet ist. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Sysparm_Display_value | Kennzeichnung, die angibt, ob die Ergebnisdaten mit dem Anzeigewert des Betreffdatensatzes bezeichnet werden sollen, wenn keine andere Bezeichnung angegeben ist. Gültige Werte:
Datentyp: Boolesch Standardwert: false |
| Sysparm_end | Erforderlich. Endzeit des Evaluierungszeitraums. Ein leerer oder fehlender Wert wird als aktuelle Zeit behandelt. Zeitwerte sind einschließlich dieser Endzeit. Datentyp: Zeichenfolge Format: ISO 8601 (UTC), entweder:
|
| Sysparm_Start | Erforderlich. Startzeit des Evaluierungszeitraums. Der Sonderwert Alle Kann verwendet werden, um die Startzeit als aktuelle Zeit abzüglich der maximalen Aufbewahrungsdauer für die angegebenen Metriken festzulegen. Ein leerer oder fehlender Wert wird als implizit behandelt Alle . Zeitwerte sind einschließlich dieser Startzeit.Datentyp: Zeichenfolge Format: ISO 8601 (UTC), entweder:
|
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Header | 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 .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| label | Bezeichnung, die zum Identifizieren des Ergebnissatzes dieser Metrik verwendet wird. Datentyp: Zeichenfolge |
| SerienRef | Datenreihenergebnisse. Datentyp: Array von Objekten |
| SeriesRef.metrik | Name der Metrik, aus der die Datenreihe abgerufen wurde. Wird nur angezeigt, wenn metricsObjekt wird in der Anforderung übergeben. Datentyp: Zeichenfolge |
| SeriesRef.Betreff | SYS_ID des Datenreihendatensatzes. Befindet sich in der in angegebenen Tabelle seriesRef.table. Datentyp: Zeichenfolge |
| SeriesRef.table | Name der Tabelle, aus der die Datenreihe abgerufen wurde. Datentyp: Zeichenfolge |
| Werte | Transformierte Serienwerte. Datentyp: Array von Objekten |
| Werte.Zeitstempel | Zeitstempel des Werts. Datentyp: Zeichenfolge Format: ISO 8601 |
| Werte.Wert | Metrikwerte. Datentyp: Zahl |
cURL-Anforderung
curl "https://instance.servicenow.com/api/now/v1/clotho/
table/mb_demo_drone/626b051787333200a328c5b836cb0b99/
mb_demo_mt_altitude?sysparm_start=2019-03-20T17%3A04%3A55
&sysparm_end=2019-03-20T17%3A09%3A55" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
"seriesRef": {
"subject": "626b051787333200a328c5b836cb0b99",
"table": "mb_demo_drone",
"metric": "mb_demo_mt_altitude"
},
"label": "626b051787333200a328c5b836cb0b99:
mb_demo_drone|mb_demo_mt_altitude",
"values": [
{
"timestamp": "2019-03-20T17:05:00Z",
"value": 83.150185
},
{
"timestamp": "2019-03-20T17:06:00Z",
"value": 83.46074
},
{
"timestamp": "2019-03-20T17:07:00Z",
"value": 83.83104
},
{
"timestamp": "2019-03-20T17:08:00Z",
"value": 84.260635
},
{
"timestamp": "2019-03-20T17:09:00Z",
"value": 84.749
}
]
}
MetricBase-Zeitreihe – GET /now/clotho/transform/{table}/{metric}
Transformiert die angegebenen Daten basierend auf den angegebenen Parametern.
URL-Format
Versionierte URL: /api/now/{api_Version}/clotho/transform/{table}/{metric}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | |
| Metrik | Name der Spalte in der Tabelle, die in identifiziert wurde subjectParameter, der als Metrik verwendet werden soll. Datentyp: Zeichenfolge |
| Tabelle | Name der Tabelle, die den GlideRecord enthält, der dieser Serie zugeordnet ist. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Sysparm_Display_value | Kennzeichnung, die angibt, ob die Ergebnisdaten mit dem Anzeigewert des Betreffdatensatzes bezeichnet werden sollen, wenn keine andere Bezeichnung angegeben ist. Gültige Werte:
Datentyp: Boolesch Standardwert: false |
| Sysparm_end | Erforderlich. Endzeit des Evaluierungszeitraums. Ein leerer oder fehlender Wert wird als aktuelle Zeit behandelt. Zeitwerte sind einschließlich dieser Endzeit. Datentyp: Zeichenfolge Format: ISO 8601 (UTC), entweder:
|
| Sysparm_query | Codierte Abfragezeichenfolge zum Suchen der Betreffdatensätze. Datentyp: Zeichenfolge Standard: Keine |
| Sysparm_Start | Erforderlich. Startzeit des Evaluierungszeitraums. Der Sonderwert Alle Kann verwendet werden, um die Startzeit als aktuelle Zeit abzüglich der maximalen Aufbewahrungsdauer für die angegebenen Metriken festzulegen. Ein leerer oder fehlender Wert wird als implizit behandelt Alle . Zeitwerte sind einschließlich dieser Startzeit.Datentyp: Zeichenfolge Format: ISO 8601 (UTC), entweder:
|
| Sysparm_subject_limit | Größe des Betreffabfrageergebnisses begrenzen. Datentyp: Zahl Standard: 10.000 |
| Sysparm_Transforms | Kommagetrennte Liste von Transformationen. Gültige Transformationen:
Datentyp: Zeichenfolge Standard: Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Header | 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 .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| label | Bezeichnung, die zum Identifizieren des Ergebnissatzes dieser Metrik verwendet wird. Datentyp: Zeichenfolge |
| SerienRef | Datenreihenergebnisse. Datentyp: Array von Objekten |
| SeriesRef.metrik | Name der Metrik, aus der die Datenreihe abgerufen wurde. Wird nur angezeigt, wenn metricsObjekt wird in der Anforderung übergeben. Datentyp: Zeichenfolge |
| SeriesRef.Betreff | SYS_ID des Datenreihendatensatzes. Befindet sich in der in angegebenen Tabelle seriesRef.table. Datentyp: Zeichenfolge |
| SeriesRef.table | Name der Tabelle, aus der die Datenreihe abgerufen wurde. Datentyp: Zeichenfolge |
| Werte | Transformierte Serienwerte. Datentyp: Array von Objekten |
| Werte.Zeitstempel | Zeitstempel des Werts. Datentyp: Zeichenfolge Format: ISO 8601 |
| Werte.Wert | Metrikwerte. Datentyp: Zahl |
cURL-Anforderung
curl "https://instance.servicenow.com/api/now/v1/clotho/
transform/mb_demo_drone/mb_demo_mt_speed?
sysparm_query=model%3DKingfisher%20Phantom&
sysparm_start=2019-03-25T17%3A04%3A55&
sysparm_end=2019-03-25T17%3A05%3A10" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
Ausgabe:
[
{
"seriesRef": {
"subject": "2a6b051787333200a328c5b836cb0b92",
"table": "mb_demo_drone",
"metric": "mb_demo_mt_speed"
},
"label": "2a6b051787333200a328c5b836cb0b92:mb_demo_drone
|mb_demo_mt_speed",
"values": [
{
"timestamp": "2019-03-25T17:05:00Z",
"value": 33.67892
}
]
},
{
"seriesRef": {
"subject": "666b051787333200a328c5b836cb0b92",
"table": "mb_demo_drone",
"metric": "mb_demo_mt_speed"
},
"label": "666b051787333200a328c5b836cb0b92:mb_demo_drone
|mb_demo_mt_speed",
"values": [
{
"timestamp": "2019-03-25T17:05:00Z",
"value": 41.94985
}
]
},
{
"seriesRef": {
"subject": "a26b051787333200a328c5b836cb0b92",
"table": "mb_demo_drone",
"metric": "mb_demo_mt_speed"
},
"label": "a26b051787333200a328c5b836cb0b92:mb_demo_drone
|mb_demo_mt_speed",
"values": [
{
"timestamp": "2019-03-25T17:05:00Z",
"value": 37.74187
}
]
},
{
"seriesRef": {
"subject": "ea6b051787333200a328c5b836cb0b92",
"table": "mb_demo_drone",
"metric": "mb_demo_mt_speed"
},
"label": "ea6b051787333200a328c5b836cb0b92:mb_demo_drone
|mb_demo_mt_speed",
"values": [
{
"timestamp": "2019-03-25T17:05:00Z",
"value": 34.914192
}
]
},
{
"seriesRef": {
"subject": "ee6b051787333200a328c5b836cb0b91",
"table": "mb_demo_drone",
"metric": "mb_demo_mt_speed"
},
"label": "ee6b051787333200a328c5b836cb0b91:mb_demo_drone
|mb_demo_mt_speed",
"values": [
{
"timestamp": "2019-03-25T17:05:00Z",
"value": 44.170887
}
]
}
]
MetricBase-Zeitreihe – POSTEN /now/clotho/accumulate
Sammelt Metrikwerte zum angegebenen Zeitstempel an und speichert das Ergebnis in der Datenbank, anstatt den Wert zu überschreiben.
Verwenden Sie diese API Zur Verarbeitung von Metriken, die für eine Akkumulation summiert werden können, z. B. Kilowattstunden (kWhs) Strom. „Accumulate“ ruft für jede Metrik zum angegebenen Zeitstempel an. Beispielsweise würden gesammelte Kilowatt für eine Heizung, einen elektrischen Wasserkocher und eine Waschmaschine dazu führen, dass drei Anrufe akkumuliert werden.
URL-Format
Versionierte URL: /api/now/{api_Version}/clotho/accumulate
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| default_value | Standardwert für die Akkumulation zu einem bestimmten Zeitstempel. Wird nur während des ersten Aufrufs verwendet, um zu akkumulieren, wenn ein Wert für einen bestimmten Zeitstempel nicht verfügbar ist. Ein Anwendungsfall könnte eine Watt-Metrik für „total_Power“ akkumulieren. Sie möchten Watt für einen Router sammeln, der an eine Steckdose ohne Leistungsmesser angeschlossen ist, um sie zu messen. Wenn Sie den Verbrauchswert kennen und konstant ist), können Sie den konstanten Wert als Standardwert verwenden, um total_Power zu akkumulieren. Sie würden beispielsweise 20 verwenden, wenn der Router ständig angeschlossen ist und 20 Watt verbraucht. Datentyp: Zeichenfolge Standard: 0 |
| sysparm_ignore_unknown_series | Kennzeichnung, die angibt, ob eine unbekannte Serie ignoriert und die Transaktion fortgesetzt werden soll, ohne einen Fehler zurückzugeben. Gültige Werte:
Standardwert: wahr |
| Name | Beschreibung |
|---|---|
| SerienRef | Liste von Zeichenfolgen, die Datenreiheninformationen darstellen, die aktualisiert werden sollen. Datentyp: Array |
| SeriesRef.metrik | Erforderlich. Name der zu aktualisierenden kumulierenden Metrik. Datentyp: Zeichenfolge |
| SeriesRef.Betreff | Erforderlich. SYS_ID des Datensatzes, in dem die Daten aktualisiert werden sollen. Datentyp: Zeichenfolge Tabelle: Angegeben in seriesRef.table |
| SeriesRef.table | Erforderlich. Name der Tabelle, in der die Daten gespeichert werden sollen. Datentyp: Zeichenfolge |
| Werte | Erforderlich. Reihenwerte, die akkumuliert und gespeichert werden sollen. Werte mit demselben Zeitstempel werden mit summiert default_valueAbfrageparameter. Datentyp: Array |
| Werte.Zeitstempel | Erforderlich. ISO 8601-Zeitstempel des Werts. Datentyp: Zeichenfolge Format: JJJJ-MM-TTTHH:mm:TTZ Das durch „Z“ dargestellte Zeichen gibt die UTC-Zeitzone in einem ISO-formatierten Zeitstempel an. Dieser Teil des Zeitstempelformats ist optional. Beispiel: |
| Werte.Wert | Erforderlich. Metrikwert. Datentyp: Zahl |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Inhaltstyp | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
| Header | 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 .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Nachricht | Nachricht, die Erfolg (OK) oder Fehler anzeigt. |
cURL-Anforderung
Dieses Beispiel zeigt, wie Metrikwerte zu einem bestimmten Zeitstempel akkumuliert werden.
curl "https://instance.servicenow.com/api/now/v1/clotho/accumulate" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"seriesRef\": {
\"subject\": \"3D666b051787333200a328c5b836cb0b92\",
\"table\": \"power_monitoring\",
\"metric\": \"total_power\"
},
\"values\": [
{
\"timestamp\": \"2019-03-21T17:05:00Z\",
\"value\": 0.150185
},
{
\"timestamp\": \"2019-03-21T17:05:00Z \",
\"value\": 0.46074
},
{
\"timestamp\": \"2019-03-21T17:05:00Z \",
\"value\": 0.83104
},
{
\"timestamp\": \"2019-03-21T17:05:00Z \",
\"value\": 1.260635
},
{
\"timestamp\": \"2019-03-21T17:05:00Z \",
\"value\": 1.749
}
]
}" \
--user "username":"password"
Ausgabe mit erfolgreichen Ergebnissen bereitgestellt.
{
"result": {
"message": "ok"
}
}
MetricBase-Zeitreihe – POSTEN SIE /now/clotho/transform
Ruft Zeitreihendaten für eine oder mehrere Metriken ab und gruppiert sie optional, nachdem eine angegebene Liste von Transformationen angewendet wurde, die eine lineare Pipeline bilden.
URL-Format
Versionierte URL: /api/now/{api_Version}/clotho/transform
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Sysparm_Display_value | Kennzeichnung, die angibt, ob die Ergebnisdaten mit dem Anzeigewert des Betreffdatensatzes bezeichnet werden sollen, wenn keine andere Bezeichnung angegeben ist. Gültige Werte:
Datentyp: Boolesch Standardwert: false |
| Name | Beschreibung |
|---|---|
| end | Erforderlich. Endzeit des Evaluierungszeitraums. Ein leerer oder fehlender Wert wird als aktuelle Zeit behandelt. Zeitwerte sind einschließlich dieser Endzeit. Datentyp: Zeichenfolge Format: ISO 8601 (UTC), entweder:
|
| limit | Maximale Anzahl zurückzugebender Datensätze. Ungewöhnlich große Werte können sich auf die Systemleistung auswirken. Datentyp: Zahl Standard: 10.000 |
| Metriken | Liste der Metrikobjekte, die in der Transformation verwendet werden sollen. Weitere Informationen zu Metriken finden Sie unter Metrics. Datentyp: Array |
| metrics.groupBy | Kommagetrennte Liste von Feldern, die in der in angegebenen Tabelle enthalten sind tableParameter, nach dem die Serie gruppiert werden soll, bevor aggregierte Transformationen erfasst oder angewendet werden. Die Reihenfolge der Elemente in der Liste ist die Reihenfolge, nach der die Daten gruppiert werden. Wenn beispielsweise zwei Elemente in der Liste vorhanden sind, „Bundesland, Postleitzahl“, wird die Serie zuerst nach Bundesland und dann nach Postleitzahl innerhalb des Bundesstaats gruppiert. Datentyp: Zeichenfolge Standard: Daten sind nicht gruppiert. |
| Metriken.Bezeichnung | Bezeichnung, die für den Ergebnissatz dieser Metrik verwendet werden soll. Ersetzt alle von der Transformationskette generierten Bezeichnungen. Datentyp: Zeichenfolge Standard: Generierte Standardbezeichnung. |
| Metriken.Metrik | Erforderlich, wenn metricsObjekt wird übergeben. Metrikfeld, das in der Transformation verwendet werden soll. Dieses Feld muss sich in der Tabelle befinden, die in angegeben ist tableParameter. Datentyp: Zeichenfolge |
| Metriken.Transformationen | Liste der Transformationen (Transformationskette), die auf die abgerufenen Zeitreihendaten angewendet werden sollen. Jede Transformation baut auf den Ergebnissen der vorherigen Transformation auf. Eine Liste der verfügbaren Transformationen finden Sie unter Unterstützte Transformationen Unten. Datentyp: Array von Objekten |
| Metriken.Transforms.arg | Abhängig von der Transformation. Parameter, die an die Transformation übergeben werden sollen. Allgemeine Richtlinien:
Datentyp: Zahl, Zeichenfolge, boolescher Wert oder JSON-Objekt, je nach Transformation. (Eine Liste der verfügbaren Transformationen finden Sie in der Tabelle Unterstützte Transformationen Unten.) |
| metrics.transforms.name | Erforderlich, wenn transformsObjekt ist angegeben. Name der Transformation. Eine Liste der verfügbaren Transformationen finden Sie in der Tabelle Unterstützte Transformationen Unten. Datentyp: Zeichenfolge |
| query | Codierte Abfrage zum Filtern des Ergebnissatzes. Sie können die Abfrage mit dem Filtereditor der angegebenen Tabelle erstellen. Wählen Sie nach der Erstellung aus URL kopieren Aus dem Breadcrumbs-Kontextmenü des Filters. Datentyp: Zeichenfolge Standard: Keine |
| start | Erforderlich. Startzeit des Evaluierungszeitraums. Der Sonderwert Alle Kann verwendet werden, um die Startzeit als aktuelle Zeit abzüglich der maximalen Aufbewahrungsdauer für die angegebenen Metriken festzulegen. Ein leerer oder fehlender Wert wird als implizit behandelt Alle . Zeitwerte sind einschließlich dieser Startzeit.Datentyp: Zeichenfolge Format: ISO 8601 (UTC), entweder:
|
| Tabelle | Erforderlich. Name der Tabelle, die den GlideRecord enthält, der dieser Serie zugeordnet ist. Datentyp: Zeichenfolge |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Inhaltstyp | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
| Header | 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 .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
| 405 | Ungültige Methode. Die Funktionalität ist deaktiviert. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Ergebnisse | Null oder mehr Rückgabeergebnisobjekte, die die Abfrage erfüllen. Enthält entweder einen seriesArray oder a groupedArray. Datentyp: Array |
| results.grouped | Liste der gruppierten Ergebnisobjekte, wobei jeweils groupedErgebnisobjekt entspricht einer bestimmten Gruppe. Dieses Format wird zurückgegeben, wenn metrics.groupByParameter wird im Anforderungstext übergeben. Datentyp: Array |
| results.grouped.groupingBy | Wert übergeben in metrics.groupByParameter in der Anforderung. Datentyp: Zeichenfolge |
| results.grouped.groups | Liste der generierten Gruppen basierend auf dem Inhalt von metrics.groupByParameter in der Anforderung. Datentyp: Array |
| results.grouped.groups.group | Name der Gruppe. Datentyp: Zeichenfolge |
| results.grouped.groups.label | Bezeichnung der Gruppe. Datentyp: Zeichenfolge |
| results.grouped.groups.series | Transformierte Werte für das Ergebnis der Gruppe. Datentyp: Array |
| results.grouped.groups.series.label | Bezeichnung der Serie. Datentyp: Zeichenfolge |
| results.grouped.groups.series.seriesRef | Ergebnisse einer einzelnen Datenreihe. Wird nicht angezeigt, wenn die Antwort mehrere Datenreihen enthält. Datentyp: Objekt |
| results.grouped.groups.series.seriesRef.metric | Name der Metrik, aus der die Datenreihe abgerufen wurde. Wird nur angezeigt, wenn metricsObjekt wird in der Anforderung übergeben. Datentyp: Zeichenfolge |
| results.grouped.groups.series.seriesRef.subject | SYS_ID des Datensatzes der Datenreihe. Datentyp: Zeichenfolge Tabelle: Tabelle, die in angegeben wurde results.series.seriesRef.tableParameter. |
| results.grouped.groups.series.seriesRef.table | Name der Tabelle, aus der die Datenreihe abgerufen wurde. Datentyp: Zeichenfolge |
| results.grouped.groups.series.values | Liste der Ergebniswerte für die Gruppe. Datentyp: Array |
| results.grouped.groups.series.values.timestamp | ISO 8601-Zeitstempel des Werts. Datentyp: Zeichenfolge |
| results.grouped.groups.series.values.value | Transformierter Wert. Datentyp: Zahl |
| Ergebnisse.Markierung | Eindeutiger Bezeichner für die entsprechenden Ergebnisse. Datentyp: Zeichenfolge |
| results.series | Liste der nicht gruppierten Serien von Ergebnisobjekten. Datentyp: Array von Objekten |
| results.series.label | Datenreihenbezeichnung. Dieser Wert wird entweder vom Endpunkt generiert oder ist der in übergebene Wert metrics.labelParameter. Datentyp: Zeichenfolge |
| results.series.seriesRef | Ergebnisse einer einzelnen Datenreihe. Wird nicht angezeigt, wenn die Antwort mehrere Datenreihen enthält. Datentyp: Objekt |
| results.series.seriesRef.metric | Name der Metrik, aus der die Datenreihe abgerufen wurde. Wird nur angezeigt, wenn metricsObjekt wird in der Anforderung übergeben. Datentyp: Zeichenfolge |
| results.series.seriesRef.subject | SYS_ID des Datenreihendatensatzes. Datentyp: Zeichenfolge Tabelle: Angegeben in results.series.seriesRef.tableParameter. |
| results.series.seriesRef.table | Name der Tabelle, aus der die Datenreihe abgerufen wurde. Datentyp: Zeichenfolge |
| results.series.values | Transformierte Serienwerte. Datentyp: Array von Objekten |
| results.series.values.timestamp | ISO 8601-Zeitstempel des Werts. Datentyp: Zeichenfolge |
| results.series.values.value | Transformierter Wert. Datentyp: Zahl |
Unterstützte Transformationen
| Transformation | Beschreibung |
|---|---|
| Hinzufügen | Fügt jedem Zeitstempelwert die angegebene Zahl hinzu. Argument: Argument (Datentyp „Dezimalzahl“) – hinzuzufügende Zahl. Zum Beispiel: |
| Automatisch korrelieren | Berechnet die Korrelation zwischen Zeitstempelwerten, getrennt durch eine steigende Anzahl von Zeiträumen ab 1. |
| durchschn | Fasst die Zeitreihe in einer Serie zusammen, die den Durchschnittswert für jeden entsprechenden Zeitstempel in der Eingabe enthält. |
| bottom | Gibt die angegebene Anzahl von Serien mit den niedrigsten Werten zurück. Argument: Argument (Ganzzahl): Die Anzahl der zurückzugebenden Serien. Beispiel: Gibt die beiden Zeitreihen zurück, die die niedrigsten Wertsätze enthalten. |
| Ceil | Rundet den Wert in jedem Zeitstempel auf die angegebene Genauigkeit auf: Ceil(Wert/<arg>) * <arg>) Argument: Argument (Datentyp „Dezimalzahl“): Dezimalgenauigkeit, auf die abgerundet werden soll. |
| erfassen | Zeigt die Transformationsergebnisse der Transformationskette bis zum Punkt des Erfassungs-Transformationsaufrufs an. Transformationsergebnisse erfassen enthalten eine eindeutige Markierung, Sie können jedoch auch eine Bezeichnung definieren. Zum Beispiel: |
| Einschränkungswerte | Ersetzt jeden Wert außerhalb des angegebenen Bereichs durch den entsprechenden Höchst- oder Mindestwert. Wenn Sie beispielsweise Folgendes angegeben haben, ersetzt die Transformation jeden Wert, der kleiner als 0 ist, durch 0 und jeden Wert, der größer als 100 ist, durch 100. Argumente:
|
| count | Fasst die Zeitreihe in einer Serie zusammen. Die neue Serie enthält die Anzahl der Werte, die nicht NaN (keine Zahl) sind, für jeden entsprechenden Zeitstempel in der Serie. |
| Ableitung | Bestimmt die Änderungsrate zwischen Zeitstempeln. Teilt die Differenz zwischen dem Wert in jedem Zeitstempel und dem Wert im nächsten Zeitstempel durch den Zeitraum des Zeitstempels. Hinweis: Diese Transformation gibt einen Wert weniger zurück als die Anzahl der Werte in der Serie. |
| Div | Dividiert den Wert in jedem Zeitstempel durch die angegebene Zahl (Argument). Argument: Arg (Dezimalzahl: Die Zahl, durch die der Wert jedes Zeitstempels geteilt werden soll. |
| Umschlag | Gibt zwei Zeitreihen zurück, wobei eine zu einem beliebigen Zeitpunkt den größten Wert und die andere den kleinsten Wert enthält. Hinweis: Nans werden ignoriert, werden jedoch zurückgegeben, wenn keine anderen Rückgabewerte vorhanden sind. |
| verwendbar bis | Erhöht den Wert der angegebenen Basis auf die Stärke des Werts in jedem Zeitstempel. Argument: Arg (Datentyp „Dezimalzahl“) – der Basiswert. |
| Filter | Wendet einen Aggregator auf den Inhalt eines gleitenden Fensters an, z. B. Erstellung eines gleitenden Durchschnitts. Argumente:
|
| Stockwerk | Rundet den Wert in jedem Zeitstempel auf die angegebene Genauigkeit ab: Stockwerk(Wert/<arg>) * <arg> Argument: Arg (Datentyp „Dezimalzahl“) – die Dezimalgenauigkeit, auf die abgerundet werden soll. |
| Bruchstücke | Gibt eine Zeitreihe für jeden Bruch im angegebenen Array zurück. Jeder Zeitstempelwert ist der Wert, bei dem der angegebene Bruch von Werten für den entsprechenden Zeitstempel in der Eingabereihe unter dem angegebenen Prozentsatz liegt. Wenn der Bruch beispielsweise 0,5 ist, ist der Wert im Zeitstempel der Wert, bei dem die Hälfte der Werte in der Eingabereihe unter 0,5 liegt. Argument: Arg (Dezimalarray): Die für die Eingabeserie zu verwendenden Brüche. Zum Beispiel: |
| groupBy | Gruppiert Daten nach den angegebenen Feldern, bevor aggregierte Transformationen erfasst oder angewendet werden. Argument: Argument (Zeichenfolge): Eine kommagetrennte Liste von Feldern in der Tabelle, die zum Gruppieren der Transformationsergebnisse verwendet werden sollen. Zum Beispiel: |
| Integrieren | Multipliziert den Wert in jedem Zeitstempel mit seinem Zeitraum. |
| Interpolieren | Erstellt einen Datenwert für ein NaN-Datenelement durch Interpolieren von angrenzenden Datenwerten. Argument: Argument (Ganzzahl): Anzahl der Datenbeispiele in jeder Richtung, die auf einen nicht-NaN-Wert überprüft werden sollen. Wenn kein nicht-NaN-Wert gefunden wird, wird NaN verwendet. |
| Umgekehrt | Berechnet die Umkehrung jedes Zeitstempelwerts. |
| iqr | Führt eine Transformation des interquartilen Bereichs durch und erstellt einen Ergebnissatz, der vier Serien enthält:
Hinweis: IQR = Q3–Q1 |
| label | Bezeichnet eine Transformationskette. Hinweis: Nachfolgende Transformationen können die Bezeichnung ändern oder ersetzen. Argument: Argument (Zeichenfolge): Text der Bezeichnung. Kann die folgenden Formatierungsausdrücke enthalten:
Zum Beispiel:
|
| limit | Gibt höchstens die angegebene Dauer oder Anzahl von Werten zurück, beginnend mit dem zuletzt gespeicherten Wert. Argumente:
|
| Protokoll | Führt einen Logarithmus für den Wert in jedem Zeitstempel aus, wobei das Ergebnis das Protokoll der angegebenen Basis für den Zeitstempelwert ist. Argument: Arg (Datentyp „Dezimalzahl“): Basis für die Logarithmus-Berechnung. |
| Zuordnungswerte | Ersetzt alle Werte innerhalb des angegebenen Bereichs (einschließlich) durch den angegebenen Wert. Wenn beides lowerBoundUnd upperBoundWerden als NaN angegeben, dann ersetzt es einen beliebigen NaN-Wert durch targetValue. Argumente:
So werden beispielsweise alle Werte in der Zeitreihe, die zwischen .1 und .9 liegen, in 1 geändert: |
| max. | Gibt eine Serie zurück, die den Höchstwert für jeden entsprechenden Zeitstempel in der Eingabe enthält. |
| Median | Erstellt eine Serie, die den Median von Werten für jeden Zeitstempel für einen Satz von Serien enthält. Wenn vorhanden n Serie:
|
| min | Gibt eine Serie zurück, die den Mindestwert für jeden entsprechenden Zeitstempel in der Eingabe enthält. |
| mul | Multipliziert den Wert in jedem Zeitstempel mit der angegebenen Zahl. Argument: Argument (Datentyp „Dezimalzahl“): Zahl, mit der der Wert jedes Zeitstempels multipliziert werden soll. |
| partition | Erstellt eine neue Serie mit Werten, die gefiltert werden, indem ein angegebener Aggregator auf ein sich nicht überschneidendes Fenster angewendet wird. Argumente:
|
| pow | Erhöht jeden Zeitstempelwert auf die angegebene Leistung. Argument: Argument (Datentyp „Dezimalzahl“) – Leistung, auf die die einzelnen Werte erhöht werden sollen. |
| Produkt | Fasst die ausgewählte Metrikreihe in einer einzelnen Serie zusammen, die das Produkt aller Werte für jeden Zeitstempel enthält. NANS sind ausgeschlossen. Wenn alle Zahlen in der Serie NaN sind, ist die Ausgabe auch NaN. |
| erneut ablesen | Führt ein erneutes Sampling einer Zeitreihe entweder auf eine feste Anzahl von Punkten oder von einer Häufigkeit zur anderen durch. Verwenden Sie die Umschreibungstransformation, um die Anzahl der Beispiele im Ergebnissatz so zu reduzieren, dass sie der Anzahl der anzuzeigenden Beispiele besser entsprechen. Argumente: Sie können verschiedene Argumente für diese Transformation übergeben. Unten finden Sie eine Liste jeder der möglichen Argumentgruppen. Nur eine dieser Argumentgruppen kann innerhalb einer einzelnen Transformation übergeben werden. Die folgenden Argumentgruppen sind durch UND/ODER gekennzeichnet. UND bedeutet, dass das Argument Teil der aktuellen Gruppe ist; ODER bedeutet, dass es der Beginn einer neuen Argumentgruppe ist.
|
| Runden | Rundet den Wert in jedem Zeitstempel auf die angegebene Genauigkeit auf: (Wert/<arg>) * <arg> Argument: Arg (Datentyp „Dezimalzahl“) – die Dezimalgenauigkeit, auf die abgerundet werden soll. |
| root | Berechnet den Stamm jedes Zeitstempelwerts anhand des angegebenen Index. Argument: Arg (Datentyp „Dezimalzahl“) – der Index des Stammes. Beispiel: Gibt die Quadratwurzel jedes Zeitstempels zurück: |
| std.-entw | Erstellt eine Serie, die die Standardabweichung von Werten für jeden Zeitstempel über einen Satz von Serien enthält. |
| Untergeordnet | Subtrahiert die angegebene Zahl vom Wert in jedem Zeitstempel. Argument: Argument (Zahl): Die Zahl, die vom Wert in jedem Zeitstempel abgezogen werden soll. |
| sum | Fasst die ausgewählte Metrikreihe in einer Serie zusammen, die die Summe aller Werte für jeden Zeitstempel enthält, ohne NaNs. Wenn alle Zahlen in der Serie NaN sind, ist die Ausgabe NaN. |
| zeitverschiebung | Verschiebt den Zeitbereich, indem der angegebene Offset zum Zeitstempel eines Werts hinzugefügt wird, ohne den Wert zu ändern. Verwenden Sie diese Transformation, um Zeitstempel in eine andere Zeitzone zu verschieben. Argument: Arg (Datentyp „Dauer“) – die Zeit für die Verschiebung. |
| top | Gibt die angegebene Anzahl von Serien mit den höchsten Werten zurück. Argument: Argument (Ganzzahl): Die Anzahl der zurückzugebenden Serien. Beispiel: Gibt die beiden Zeitreihen zurück, die die höchsten Wertsätze enthalten. |
| Datentyp | Beschreibung |
|---|---|
| Aggregator | Verfügbare Aggregatoren, die innerhalb der Transformation verwendet werden sollen.
|
| DateTime | Absolute Datums-/Uhrzeitwerte werden im ISO 8601-Datums- und Uhrzeitformat angegeben: JJJJ-MM-TTThh:mm:ss . Beispiel: 2020-02-28T13:10:42.Wobei:
Relative Datums-/Uhrzeitwerte werden mithilfe einer Dauer (Datentyp „Dauer“) angegeben, die von der aktuellen Uhrzeit subtrahiert wird. Beispiel: P7D = vor sieben Tagen. |
| Dezimal | Dezimalwert, der entweder:
|
| Dauer | Zeit in einem Zeitintervall. Dauerwerte werden im ISO 8601-Dauerformat angegeben: P[n]Y[n]M[n]DT[n]H[n]M[n]S Wobei:
Zum Beispiel:
|
cURL-Anforderung
curl "https://instance.servicenow.com/api/now/v1/clotho/transform \
--request POST \
--header "Accept:application/json", "Content-Type:application/json" \
--user "username":"password"
-d {\
"start": "PT15M",\
"end": "",\
"table": "mb_demo_drone",\
"query": "fleet.nameSTARTSWITHB",\
"limit": 5000,\
"metrics": [\
{\
"metric": "mb_demo_mt_altitude",\
"label": "Series - Avg",\
"transforms": [\
{\
"name": "partition",\
"arg": {\
"aggregator": "AVG",\
"window": "PT5M"\
}\
},
{\
"name": "avg"\
}\
]\
},
{\
"metric": "mb_demo_mt_altitude",\
"groupBy": "fleet",\
"label": "Fleet - AVG",\
"transforms": [\
{\
"name": "partition",\
"arg": {\
"aggregator": "AVG",\
"window": "PT5M"\
}\
},
{\
"name": "avg"\
}\
]\
}\
]\
} \
Ausgabe:
"results:" [
{
"marker": "674d86ba-a810-4065-942b-0b7ca2f95db2",
"series": [
{
"label": "Series - Avg",
"values": [
{
"timestamp": "2020-05-01T21:05:00Z",
"value": 157.43086
},
{
"timestamp": "2020-05-01T21:10:00Z",
"value": 162.92278
}
]
}
]
},
{
"marker": "846aa334-232a-4015-b033-d18ebc4b1d23",
"grouped": [
{
"groupingBy": "fleet",
"groups": [
{
"group": "86fac11787333200a328c5b836cb0b4e",
"label": "Bantams",
"series": {
"label": "Fleet - AVG",
"values": [
{
"timestamp": "2020-05-01T21:05:00Z",
"value": 159.70201
},
{
"timestamp": "2020-05-01T21:10:00Z",
"value": 165.1136
}
]
}
},
{
"group": "4afac11787333200a328c5b836cb0b4e",
"label": "Bumble Untd",
"series": {
"label": "Fleet - AVG",
"values": [
{
"timestamp": "2020-05-01T21:05:00Z",
"value": 154.5403
},
{
"timestamp": "2020-05-01T21:10:00Z",
"value": 160.13445
}
]
}
}
]
}
]
}
]
MetricBase-Zeitreihe – POST /now/clotho/transform/Stream
Gibt einen Stream von transformierten Zeitreihendaten für eine oder mehrere Metriken zurück, nachdem die angegebene Liste der Transformationen angewendet wurde.
Durch das Streaming von Daten auf diese Weise können Sie die Daten verarbeiten, wenn einzelne Transformationen abgeschlossen und zurückgegeben werden, anstatt darauf zu warten, dass alle Transformationsergebnisse abgeschlossen und heruntergeladen wurden. Wenn große Datenmengen vom Client verarbeitet werden müssen, reduziert diese Art der Verarbeitung die End-to-End-Verarbeitungszeit und reduziert potenziell die Arbeitsspeichernutzung auf dem Client.
- Geben Sie die gestreamten Daten an, die in einem Binärformat codiert werden sollen.
- Serialisieren Sie gestreamte Daten in ein JSON-Array, oder
- Streamen Sie Daten in einem breiten oder schmalen CSV-Format zurück an den Client.
URL-Format
Versionierte URL: /api/now/{api_Version}/clotho/transform/Stream
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Sysparm_Display_value | Kennzeichnung, die angibt, ob die Ergebnisdaten mit dem Anzeigewert des Betreffdatensatzes bezeichnet werden sollen, wenn keine andere Bezeichnung angegeben ist. Gültige Werte:
Datentyp: Boolesch Standardwert: false |
| Name | Beschreibung |
|---|---|
| end | Erforderlich. Endzeit des Evaluierungszeitraums. Ein leerer oder fehlender Wert wird als aktuelle Zeit behandelt. Zeitwerte sind einschließlich dieser Endzeit. Datentyp: Zeichenfolge Format: ISO 8601 (UTC), entweder:
|
| limit | Maximale Anzahl zurückzugebender Datensätze. Ungewöhnlich große Werte können sich auf die Systemleistung auswirken. Datentyp: Zahl Standard: 10.000 |
| Metriken | Liste der Metrikobjekte, die in der Transformation verwendet werden sollen. Weitere Informationen zu Metriken finden Sie unter Metriken . Datentyp: Array |
| Metriken.Bezeichnung | Bezeichnung, die für den Ergebnissatz dieser Metrik verwendet werden soll. Ersetzt alle von der Transformationskette generierten Bezeichnungen. Datentyp: Zeichenfolge Standard: Generierte Standardbezeichnung. |
| Metriken.Metrik | Erforderlich, wenn metricsObjekt wird übergeben. Metrikfeld, das in der Transformation verwendet werden soll. Dieses Feld muss sich in der Tabelle befinden, die in angegeben ist tableParameter. Datentyp: Zeichenfolge |
| Metriken.Transformationen | Liste der Transformationen (Transformationskette), die auf die abgerufenen Zeitreihendaten angewendet werden sollen. Jede Transformation baut auf den Ergebnissen der vorherigen Transformation auf. Eine Liste der verfügbaren Transformationen finden Sie unter Unterstützte Transformationen Unten. Datentyp: Array von Objekten |
| Metriken.Transforms.arg | Abhängig von der Transformation. Parameter, die an die Transformation übergeben werden sollen. Allgemeine Richtlinien:
Datentyp: Zahl, Zeichenfolge, boolescher Wert oder JSON-Objekt, je nach Transformation. (Eine Liste der verfügbaren Transformationen finden Sie in der Tabelle Unterstützte Transformationen Unten.) |
| metrics.transforms.name | Erforderlich, wenn transformsObjekt ist angegeben. Name der Transformation. Eine Liste der verfügbaren Transformationen finden Sie in der Tabelle Unterstützte Transformationen Unten. Datentyp: Zeichenfolge |
| query | Codierte Abfrage zum Filtern des Ergebnissatzes. Sie können die Abfrage mit dem Filtereditor der angegebenen Tabelle erstellen. Wählen Sie nach der Erstellung aus URL kopieren Aus dem Breadcrumbs-Kontextmenü des Filters. Datentyp: Zeichenfolge Standard: Keine |
| start | Erforderlich. Startzeit des Evaluierungszeitraums. Der Sonderwert Alle Kann verwendet werden, um die Startzeit als aktuelle Zeit abzüglich der maximalen Aufbewahrungsdauer für die angegebenen Metriken festzulegen. Ein leerer oder fehlender Wert wird als implizit behandelt Alle . Zeitwerte sind einschließlich dieser Startzeit.Datentyp: Zeichenfolge Format: ISO 8601 (UTC), entweder:
|
| Tabelle | Erforderlich. Name der Tabelle, die den GlideRecord enthält, der dieser Serie zugeordnet ist. Datentyp: Zeichenfolge |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt Folgendes:
Text/csv;Format=Narrow Oder Text/csv;Format=Wide . |
| Inhaltstyp | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
| Header | Beschreibung |
|---|---|
| Keine | Datenformat des Antworttexts. Verwenden Sie basierend auf den angegebenen Akzeptanzwerten der Anforderung:
Wenn mehrere Akzeptanztypen angegeben sind, wird der erste unterstützte Typ zurückgegeben. |
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 .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet, und das Streaming der Daten wird gestartet. Hinweis: Eine Antwort von 200 kann weiterhin zu einem Verarbeitungsfehler im Midstream führen, wenn die Transformationen berechnet werden. |
| 400 | Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
| 405 | Ungültige Methode. Die Funktionalität ist deaktiviert. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler. |
Antworttext-Parameter (Octet-Stream oder JSON)
| Name | Beschreibung |
|---|---|
| Ausgabestrom (Oktet-Stream) | Wenn der Header der Akzeptanz-Anforderung auf festgelegt ist application/octet-stream, Die übereinstimmenden MetricBase-Daten werden als binärer serialisierter Stream zurückgegeben. Clotho-Util für Java-Anwendungen bietet einen Deserialisierer, mit dem Sie diese Daten analysieren können. Der Stream besteht aus einer binären Serialisierung jedes Datums, gefolgt von einer Ganzzahl, die seine Länge darstellt. Die folgenden Einträge beschreiben die Daten innerhalb der Binärdarstellung und die Reihenfolge dieser Daten. |
| CSV-Stream (UTF-8-Stream) | Wenn der Header der Akzeptanz-Anforderung auf festgelegt ist text/csv, Die übereinstimmenden MetricBase-Daten werden als UTF-8-codierte CSV-Daten in breiten oder engen Formaten zurückgegeben. Ein schmales Format gibt Betreff- und Zeitstempelspalten und eine Spalte für jede zurückgegebene Metrik zurück. Ein Breitformat gibt eine Zeitstempelspalte mit einer separaten Spalte für jedes Metrik-Betreffpaar zurück. |
| Betreff | Quelle der Daten. Wenn die Metrik für die Daten beispielsweise Drohnen-Höhen ist, kann dieser Wert die ID einer bestimmten Drohne sein. Wenn ein Doppelpunkt im Wert enthalten ist, stellen die Teile nach dem Betreff die Metrik dar, zu der die Daten gehören. Null-Werte werden durch eine codierte leere Zeichenfolge dargestellt. Datentyp: Zeichenfolge (von Java geänderte UTF) Größe: 2+ Byte |
| Maß | Metrik, aus der die Daten stammen. Null-Werte werden durch eine codierte leere Zeichenfolge dargestellt. Datentyp: Zeichenfolge (von Java geänderte UTF) Größe: 2+ Byte |
| Bezeichnung | Bezeichnung der Daten. Null-Werte werden durch eine codierte leere Zeichenfolge dargestellt. Datentyp: Zeichenfolge (von Java geänderte UTF) Größe: 2+ Byte |
| Typ | Typ der in einem Byte codierten Daten. Mögliche Werte:
Datentyp: Byte Größe: 1 Byte |
| Flags | Codiert serializeFlagsVariable. Wenn serializeTagsIst „wahr“, und die Daten enthalten Tags. Der Wert ist 2, andernfalls 0. Datentyp: Byte Größe: 1 Byte |
| Zeitraum | Zeitraum, der den Daten zugeordnet ist. Datentyp: Zahl (Ganzzahl) Größe: 4 Byte |
| Anzahl der Tags | Wenn serializeTagsIst „wahr“, dann ist dies die Anzahl der in den Daten gespeicherten Tags. Datentyp: Zahl (Ganzzahl) Größe: 4 Byte |
| Tags | Wenn serializeTagsIst „wahr“, wird jedes Tag in den Daten gespeichert. Datentyp: Zeichenfolge (von Java geänderte UTF) Größe: Abhängig von der Anzahl der Tags (2+ Byte). |
| Startepoche Sekunde | UTC-Zeit der Epoche, die die Startzeit dieser Datenreihe darstellt. Datentyp: Zahl (lang) Größe: 8 Byte |
| Anzahl der Werte | Anzahl der in diesen Daten gespeicherten Werte. Datentyp: Zahl (Ganzzahl) Größe: 4 Byte |
| Werte | Wenn TypeIst Gleitkommasignal , Dann besteht der Rest aus Gleitkommawerten. Größe: Number of Values* 4 Datentyp: Zahl (Gleitkommazahl) |
| Werte | Wenn TypeIst Doppeltes Signal , Dann besteht der Rest aus doppelten Werten. Datentyp: Zahl (doppelt) Größe: Number of Values* 4 Byte |
| Modell-Json (Modell) | Wenn TypeIst Gleitkommamodell Oder Doppeltes Modell , Der Rest ist eine von Java geänderte UTF-Zeichenfolge, die das Modell als JSON darstellt. Datentyp: Zeichenfolge (von Java geänderte UTF) Größe: 2+ Byte |
| Markierung Für Großes Modell (Großes Modell) | Wenn die Länge der JSON des Modells mehr als 65.535 Byte beträgt, wird dieses Feld anstelle von geschrieben Model Json. Datentyp: Zeichenfolge (von Java geänderte UTF) Größe: 5 |
| Große Modellgröße (Großes Modell) | Länge der JSON-Darstellung des großen Modells. Datentyp: Zahl (Ganzzahl) Größe: 4 Byte |
| Großes Modell – Json (Großes Modell) | JSON-Darstellung des Modells als Reihe von UTF-Zeichen, die Größe wird von bestimmt Big Model SizeFeld. Datentyp: Zeichenfolge (UTF-Zeichen) Größe: 65535-256000 Byte |
| JSON-Stream (JSON) | Wenn der Header der Akzeptanz-Anforderung auf festgelegt ist application/json, Die übereinstimmenden MetricBase-Daten werden als Stream neuer zeilengetrennter JSON-Objekte zurückgegeben. Die folgenden Einträge beschreiben die möglichen Elemente in jedem zurückgegebenen Objekt. |
| label | Bezeichnung der Daten. Dieser Wert wird entweder vom Endpunkt generiert oder ist der in übergebene Wert metrics.labelParameter. Datentyp: Zeichenfolge |
| Zeitraum | Zeit zwischen jedem Wert. Ein Zeitraum von 60 würde beispielsweise bedeuten, dass jeder Wert eine Minute voneinander entfernt ist. Datentyp: Zahl Einheit: Sekunden |
| Bereich | Start- und Endzeiten der Daten Datentyp: Array Format: ISO 8601 (UTC) |
| Serie | Gibt die einzelnen Daten an. Wenn vorhanden, wird normalerweise in Form von angezeigt [Glide-Datensatz-ID]:[Metrik] . Dies ist möglicherweise nicht vorhanden, wenn Transformationen verwendet werden.Datentyp: Zeichenfolge |
| Arten | Typ der Rückgabedaten. Für eine Reihe von FLOAT- oder Doppel-Werten ist dies entweder FLOAT_SIGNAL oder DOUBLE_SIGNAL. Für ein Modell, das Float- oder Double-Daten analysieren soll, ist dies entweder „FLOAT_MODEL“ oder „DOUBLE_MODEL“. Datentyp: Zeichenfolge |
| tags | Tags, die den Daten zugeordnet sind. Datentyp: Array von Zeichenfolgen |
| Wert | Gleitkommawerte oder doppelte Werte für die Daten. Datentyp: Array von Zahlen |
| Fehler | Fehlermeldung, wenn die Transformation der angegebenen Datenreihe fehlschlägt. Datentyp: Zeichenfolge |
Unterstützte Transformationen
| Transformation | Beschreibung |
|---|---|
| Hinzufügen | Fügt jedem Zeitstempelwert die angegebene Zahl hinzu. Argument: Argument (Datentyp „Dezimalzahl“) – hinzuzufügende Zahl. Zum Beispiel: |
| Automatisch korrelieren | Berechnet die Korrelation zwischen Zeitstempelwerten, getrennt durch eine steigende Anzahl von Zeiträumen ab 1. |
| durchschn | Fasst die Zeitreihe in einer Serie zusammen, die den Durchschnittswert für jeden entsprechenden Zeitstempel in der Eingabe enthält. |
| bottom | Gibt die angegebene Anzahl von Serien mit den niedrigsten Werten zurück. Argument: Argument (Ganzzahl): Die Anzahl der zurückzugebenden Serien. Beispiel: Gibt die beiden Zeitreihen zurück, die die niedrigsten Wertsätze enthalten. |
| Ceil | Rundet den Wert in jedem Zeitstempel auf die angegebene Genauigkeit auf: Ceil(Wert/<arg>) * <arg>) Argument: Argument (Datentyp „Dezimalzahl“): Dezimalgenauigkeit, auf die abgerundet werden soll. |
| erfassen | Zeigt die Transformationsergebnisse der Transformationskette bis zum Punkt des Erfassungs-Transformationsaufrufs an. Transformationsergebnisse erfassen enthalten eine eindeutige Markierung, Sie können jedoch auch eine Bezeichnung definieren. Zum Beispiel: |
| Einschränkungswerte | Ersetzt jeden Wert außerhalb des angegebenen Bereichs durch den entsprechenden Höchst- oder Mindestwert. Wenn Sie beispielsweise Folgendes angegeben haben, ersetzt die Transformation jeden Wert, der kleiner als 0 ist, durch 0 und jeden Wert, der größer als 100 ist, durch 100. Argumente:
|
| count | Fasst die Zeitreihe in einer Serie zusammen. Die neue Serie enthält die Anzahl der Werte, die nicht NaN (keine Zahl) sind, für jeden entsprechenden Zeitstempel in der Serie. |
| Ableitung | Bestimmt die Änderungsrate zwischen Zeitstempeln. Teilt die Differenz zwischen dem Wert in jedem Zeitstempel und dem Wert im nächsten Zeitstempel durch den Zeitraum des Zeitstempels. Hinweis: Diese Transformation gibt einen Wert weniger zurück als die Anzahl der Werte in der Serie. |
| Div | Dividiert den Wert in jedem Zeitstempel durch die angegebene Zahl (Argument). Argument: Arg (Dezimalzahl: Die Zahl, durch die der Wert jedes Zeitstempels geteilt werden soll. |
| Umschlag | Gibt zwei Zeitreihen zurück, wobei eine zu einem beliebigen Zeitpunkt den größten Wert und die andere den kleinsten Wert enthält. Hinweis: Nans werden ignoriert, werden jedoch zurückgegeben, wenn keine anderen Rückgabewerte vorhanden sind. |
| verwendbar bis | Erhöht den Wert der angegebenen Basis auf die Stärke des Werts in jedem Zeitstempel. Argument: Arg (Datentyp „Dezimalzahl“) – der Basiswert. |
| Filter | Wendet einen Aggregator auf den Inhalt eines gleitenden Fensters an, z. B. Erstellung eines gleitenden Durchschnitts. Argumente:
|
| Stockwerk | Rundet den Wert in jedem Zeitstempel auf die angegebene Genauigkeit ab: Stockwerk(Wert/<arg>) * <arg> Argument: Arg (Datentyp „Dezimalzahl“) – die Dezimalgenauigkeit, auf die abgerundet werden soll. |
| Bruchstücke | Gibt eine Zeitreihe für jeden Bruch im angegebenen Array zurück. Jeder Zeitstempelwert ist der Wert, bei dem der angegebene Bruch von Werten für den entsprechenden Zeitstempel in der Eingabereihe unter dem angegebenen Prozentsatz liegt. Wenn der Bruch beispielsweise 0,5 ist, ist der Wert im Zeitstempel der Wert, bei dem die Hälfte der Werte in der Eingabereihe unter 0,5 liegt. Argument: Arg (Dezimalarray): Die für die Eingabeserie zu verwendenden Brüche. Zum Beispiel: |
| groupBy | Gruppiert Daten nach den angegebenen Feldern, bevor aggregierte Transformationen erfasst oder angewendet werden. Argument: Argument (Zeichenfolge): Eine kommagetrennte Liste von Feldern in der Tabelle, die zum Gruppieren der Transformationsergebnisse verwendet werden sollen. Zum Beispiel: |
| Integrieren | Multipliziert den Wert in jedem Zeitstempel mit seinem Zeitraum. |
| Interpolieren | Erstellt einen Datenwert für ein NaN-Datenelement durch Interpolieren von angrenzenden Datenwerten. Argument: Argument (Ganzzahl): Anzahl der Datenbeispiele in jeder Richtung, die auf einen nicht-NaN-Wert überprüft werden sollen. Wenn kein nicht-NaN-Wert gefunden wird, wird NaN verwendet. |
| Umgekehrt | Berechnet die Umkehrung jedes Zeitstempelwerts. |
| iqr | Führt eine Transformation des interquartilen Bereichs durch und erstellt einen Ergebnissatz, der vier Serien enthält:
Hinweis: IQR = Q3–Q1 |
| label | Bezeichnet eine Transformationskette. Hinweis: Nachfolgende Transformationen können die Bezeichnung ändern oder ersetzen. Argument: Argument (Zeichenfolge): Text der Bezeichnung. Kann die folgenden Formatierungsausdrücke enthalten:
Zum Beispiel:
|
| limit | Gibt höchstens die angegebene Dauer oder Anzahl von Werten zurück, beginnend mit dem zuletzt gespeicherten Wert. Argumente:
|
| Protokoll | Führt einen Logarithmus für den Wert in jedem Zeitstempel aus, wobei das Ergebnis das Protokoll der angegebenen Basis für den Zeitstempelwert ist. Argument: Arg (Datentyp „Dezimalzahl“): Basis für die Logarithmus-Berechnung. |
| Zuordnungswerte | Ersetzt alle Werte innerhalb des angegebenen Bereichs (einschließlich) durch den angegebenen Wert. Wenn beides lowerBoundUnd upperBoundWerden als NaN angegeben, dann ersetzt es einen beliebigen NaN-Wert durch targetValue. Argumente:
So werden beispielsweise alle Werte in der Zeitreihe, die zwischen .1 und .9 liegen, in 1 geändert: |
| max. | Gibt eine Serie zurück, die den Höchstwert für jeden entsprechenden Zeitstempel in der Eingabe enthält. |
| Median | Erstellt eine Serie, die den Median von Werten für jeden Zeitstempel für einen Satz von Serien enthält. Wenn vorhanden n Serie:
|
| min | Gibt eine Serie zurück, die den Mindestwert für jeden entsprechenden Zeitstempel in der Eingabe enthält. |
| mul | Multipliziert den Wert in jedem Zeitstempel mit der angegebenen Zahl. Argument: Argument (Datentyp „Dezimalzahl“): Zahl, mit der der Wert jedes Zeitstempels multipliziert werden soll. |
| partition | Erstellt eine neue Serie mit Werten, die gefiltert werden, indem ein angegebener Aggregator auf ein sich nicht überschneidendes Fenster angewendet wird. Argumente:
|
| pow | Erhöht jeden Zeitstempelwert auf die angegebene Leistung. Argument: Argument (Datentyp „Dezimalzahl“) – Leistung, auf die die einzelnen Werte erhöht werden sollen. |
| Produkt | Fasst die ausgewählte Metrikreihe in einer einzelnen Serie zusammen, die das Produkt aller Werte für jeden Zeitstempel enthält. NANS sind ausgeschlossen. Wenn alle Zahlen in der Serie NaN sind, ist die Ausgabe auch NaN. |
| erneut ablesen | Führt ein erneutes Sampling einer Zeitreihe entweder auf eine feste Anzahl von Punkten oder von einer Häufigkeit zur anderen durch. Verwenden Sie die Umschreibungstransformation, um die Anzahl der Beispiele im Ergebnissatz so zu reduzieren, dass sie der Anzahl der anzuzeigenden Beispiele besser entsprechen. Argumente: Sie können verschiedene Argumente für diese Transformation übergeben. Unten finden Sie eine Liste jeder der möglichen Argumentgruppen. Nur eine dieser Argumentgruppen kann innerhalb einer einzelnen Transformation übergeben werden. Die folgenden Argumentgruppen sind durch UND/ODER gekennzeichnet. UND bedeutet, dass das Argument Teil der aktuellen Gruppe ist; ODER bedeutet, dass es der Beginn einer neuen Argumentgruppe ist.
|
| Runden | Rundet den Wert in jedem Zeitstempel auf die angegebene Genauigkeit auf: (Wert/<arg>) * <arg> Argument: Arg (Datentyp „Dezimalzahl“) – die Dezimalgenauigkeit, auf die abgerundet werden soll. |
| root | Berechnet den Stamm jedes Zeitstempelwerts anhand des angegebenen Index. Argument: Arg (Datentyp „Dezimalzahl“) – der Index des Stammes. Beispiel: Gibt die Quadratwurzel jedes Zeitstempels zurück: |
| std.-entw | Erstellt eine Serie, die die Standardabweichung von Werten für jeden Zeitstempel über einen Satz von Serien enthält. |
| Untergeordnet | Subtrahiert die angegebene Zahl vom Wert in jedem Zeitstempel. Argument: Argument (Zahl): Die Zahl, die vom Wert in jedem Zeitstempel abgezogen werden soll. |
| sum | Fasst die ausgewählte Metrikreihe in einer Serie zusammen, die die Summe aller Werte für jeden Zeitstempel enthält, ohne NaNs. Wenn alle Zahlen in der Serie NaN sind, ist die Ausgabe NaN. |
| zeitverschiebung | Verschiebt den Zeitbereich, indem der angegebene Offset zum Zeitstempel eines Werts hinzugefügt wird, ohne den Wert zu ändern. Verwenden Sie diese Transformation, um Zeitstempel in eine andere Zeitzone zu verschieben. Argument: Arg (Datentyp „Dauer“) – die Zeit für die Verschiebung. |
| top | Gibt die angegebene Anzahl von Serien mit den höchsten Werten zurück. Argument: Argument (Ganzzahl): Die Anzahl der zurückzugebenden Serien. Beispiel: Gibt die beiden Zeitreihen zurück, die die höchsten Wertsätze enthalten. |
| Datentyp | Beschreibung |
|---|---|
| Aggregator | Verfügbare Aggregatoren, die innerhalb der Transformation verwendet werden sollen.
|
| DateTime | Absolute Datums-/Uhrzeitwerte werden im ISO 8601-Datums- und Uhrzeitformat angegeben: JJJJ-MM-TTThh:mm:ss . Beispiel: 2020-02-28T13:10:42.Wobei:
Relative Datums-/Uhrzeitwerte werden mithilfe einer Dauer (Datentyp „Dauer“) angegeben, die von der aktuellen Uhrzeit subtrahiert wird. Beispiel: P7D = vor sieben Tagen. |
| Dezimal | Dezimalwert, der entweder:
|
| Dauer | Zeit in einem Zeitintervall. Dauerwerte werden im ISO 8601-Dauerformat angegeben: P[n]Y[n]M[n]DT[n]H[n]M[n]S Wobei:
Zum Beispiel:
|
cURL-Anforderung
Das folgende Beispiel zeigt, wie dieser Endpunkt aufgerufen wird, um einen JSON-Stream für Metriken in der Tabelle „mb_Demo_drone“ zurückzugeben. Hinweis: Während die Objekte in diesem Beispiel zur Lesbarkeit auf mehrere Zeilen erweitert werden, befindet sich jedes zurückgegebene Objekt in einem tatsächlichen Ergebnis in einer eigenen Zeile. Sie können denselben Anruf tätigen und einen Oktett-Stream zurückgeben, indem Sie festlegen --Header „Accept:Application/octet-Stream“ \ .
curl "localhost:8080/api/now/v1/clotho/transform/stream" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--user "username":"password" \
-d "{\
\"start\": \"PT5M\",\
\"end\": \"\",\
\"table\": \"mb_demo_drone\",\
\"query\": \"fleet.nameSTARTSWITHB\",\
\"limit\": 5000,\
\"metrics\": [\
{\
\"metric\": \"mb_demo_mt_altitude\",\
\"label\": \"Series - Avg\",\
\"transforms\": [\
{\
\"name\": \"partition\",\
\"arg\": {\
\"aggregator\": \"AVG\",\
\"window\": \"PT5M\"\
}\
},
{\
\"name\": \"avg\"\
}\
]\
},
{\
\"metric\": \"mb_demo_mt_altitude\",\
\"groupBy\": \"fleet\",\
\"label\": \"Fleet - AVG\",\
\"transforms\": [\
{\
\"name\": \"partition\",\
\"arg\": {\
\"aggregator\": \"AVG\",\
\"window\": \"PT5M\"\
}\
},
{\
\"name\": \"avg\"\
}\
]\
}\
]\
}"
Antwort:
[
{
"label": "Series - Avg",
"tags": [
"#4fb1114f-2426-4acb-8e3e-6435dd62134c"
],
"species": "DOUBLE_SIGNAL",
"range": [
"2022-06-16T17:50:00Z",
"2022-06-16T17:50:00Z"
],
"values": [
132.86805196126303
],
"period": 300
},
{
"label": "Fleet - AVG",
"tags": [
":fleet:86fac11787333200a328c5b836cb0b4e:Bantams",
"#6641aab4-c55f-4d11-8846-26b0b706ec1c"
],
"species": "DOUBLE_SIGNAL",
"range": [
"2022-06-16T17:50:00Z",
"2022-06-16T17:50:00Z"
],
"values": [
134.3775875908988
],
"period": 300
},
{
"label": "Fleet - AVG",
"tags": [
"#6641aab4-c55f-4d11-8846-26b0b706ec1c",
":fleet:4afac11787333200a328c5b836cb0b4e:Bumble Untd"
],
"species": "DOUBLE_SIGNAL",
"range": [
"2022-06-16T17:50:00Z",
"2022-06-16T17:50:00Z"
],
"values": [
129.02530271356756
],
"period": 300
}
]
Das folgende Curl-Beispiel verwendet die CSV-Formatoption, um die Höhenwerte (in der Datenbank als „mb_demo_mt_altitude“ gespeichert) des letzten Tages für jede Drohne zurückzustreamen, die in der Tabelle mb_Demo_Drone [Drones] des Metricbase-Demo-Plugins gespeichert ist. Im Beispiel werden die Daten in einem schmalen Tabellenformat mit drei Spalten zurückgegeben: Die SYS_ID des Betreffs, der die Drohne identifiziert, den Zeitstempel des Werts und den Höhenwert.
curl "https://instance.servicenow.com/api/now/v1/clotho/transform/stream" \
--request POST \
--header "Accept:text/csv;format=narrow" \
--header "Content-Type:application/json" \
--user "user name":"password" \
-d "{\
\"start\": \"P1D\",\
\"end\": \"\",\
\"table\": \"mb_demo_drone\",\
\"metrics\": [\
{\
\"metric\": \"mb_demo_mt_altitude\",\
\"transforms\": []\
}]\
}"
Ausgabe:
Subject, Timestamp,"mb_demo_drone|mb_demo_mt_altitude"
"a66b051787333200a328c5b836cb0b97",2022-11-07T22:35:00Z,92.84400939941406
"a66b051787333200a328c5b836cb0b94",2022-11-07T22:35:00Z,92.2428970336914
"6a6b051787333200a328c5b836cb0b97",2022-11-07T22:35:00Z,92.0076904296875
"ea6b051787333200a328c5b836cb0b92",2022-11-07T22:35:00Z,97.3113021850586
"a66b051787333200a328c5b836cb0b91",2022-11-07T22:35:00Z,108.49791717529297
"6a6b051787333200a328c5b836cb0b94",2022-11-07T22:35:00Z,109.04239654541016
"6a6b051787333200a328c5b836cb0b91",2022-11-07T22:35:00Z,93.72159576416016
"ee6b051787333200a328c5b836cb0b91",2022-11-07T22:35:00Z,107.69989776611328
"ee6b051787333200a328c5b836cb0b97",2022-11-07T22:35:00Z,100.86473083496094
"ee6b051787333200a328c5b836cb0b94",2022-11-07T22:35:00Z,95.77774047851562
"666b051787333200a328c5b836cb0b92",2022-11-07T22:35:00Z,105.19712829589844
"666b051787333200a328c5b836cb0b95",2022-11-07T22:35:00Z,105.92308807373047
"6e6b051787333200a328c5b836cb0b99",2022-11-07T22:35:00Z,93.59339141845703
"666b051787333200a328c5b836cb0b98",2022-11-07T22:35:00Z,94.51266479492188
"e26b051787333200a328c5b836cb0b94",2022-11-07T22:35:00Z,105.4367904663086
"6e6b051787333200a328c5b836cb0b96",2022-11-07T22:35:00Z,94.64836883544922
"6e6b051787333200a328c5b836cb0b93",2022-11-07T22:35:00Z,94.78523254394531
"e26b051787333200a328c5b836cb0b97",2022-11-07T22:35:00Z,96.99283599853516
"aa6b051787333200a328c5b836cb0b96",2022-11-07T22:35:00Z,106.67017364501953
"e26b051787333200a328c5b836cb0b91",2022-11-07T22:35:00Z,94.2446517944336
"aa6b051787333200a328c5b836cb0b93",2022-11-07T22:35:00Z,91.659912109375
"226b051787333200a328c5b836cb0b94",2022-11-07T22:35:00Z,99.5401840209961
"226b051787333200a328c5b836cb0b97",2022-11-07T22:35:00Z,98.13501739501953
"226b051787333200a328c5b836cb0b91",2022-11-07T22:35:00Z,92.2428970336914
"226b051787333200a328c5b836cb0b90",2022-11-07T22:35:00Z,106.41876983642578
"aa6b051787333200a328c5b836cb0b99",2022-11-07T22:35:00Z,107.69989776611328
"626b051787333200a328c5b836cb0b93",2022-11-07T22:35:00Z,92.96666717529297
"e66b051787333200a328c5b836cb0b99",2022-11-07T22:35:00Z,93.85079193115234
"e66b051787333200a328c5b836cb0b93",2022-11-07T22:35:00Z,96.07303619384766
"e66b051787333200a328c5b836cb0b96",2022-11-07T22:35:00Z,98.47595977783203
"2a6b051787333200a328c5b836cb0b92",2022-11-07T22:35:00Z,95.9247055053711
"226b051787333200a328c5b836cb0b9a",2022-11-07T22:35:00Z,99.5401840209961
"2a6b051787333200a328c5b836cb0b98",2022-11-07T22:35:00Z,103.1417465209961
"2a6b051787333200a328c5b836cb0b95",2022-11-07T22:35:00Z,96.99283599853516
"ae6b051787333200a328c5b836cb0b95",2022-11-07T22:35:00Z,94.64836883544922
"ae6b051787333200a328c5b836cb0b98",2022-11-07T22:35:00Z,101.8689956665039
"ae6b051787333200a328c5b836cb0b92",2022-11-07T22:35:00Z,107.4388198852539
"a26b051787333200a328c5b836cb0b98",2022-11-07T22:35:00Z,94.78523254394531
"266b051787333200a328c5b836cb0b93",2022-11-07T22:35:00Z,94.51266479492188
"2e6b051787333200a328c5b836cb0b97",2022-11-07T22:35:00Z,108.49791717529297
"2e6b051787333200a328c5b836cb0b91",2022-11-07T22:35:00Z,97.15129852294922
"2e6b051787333200a328c5b836cb0b94",2022-11-07T22:35:00Z,103.36128997802734
"a26b051787333200a328c5b836cb0b92",2022-11-07T22:35:00Z,100.47681427001953
"266b051787333200a328c5b836cb0b96",2022-11-07T22:35:00Z,103.5830078125
"266b051787333200a328c5b836cb0b99",2022-11-07T22:35:00Z,97.3113021850586
"a26b051787333200a328c5b836cb0b95",2022-11-07T22:35:00Z,105.92308807373047
"ea6b051787333200a328c5b836cb0b98",2022-11-07T22:35:00Z,95.34477996826172
"ea6b051787333200a328c5b836cb0b95",2022-11-07T22:35:00Z,100.47681427001953
"626b051787333200a328c5b836cb0b99",2022-11-07T22:35:00Z,100.86473083496094
"626b051787333200a328c5b836cb0b96",2022-11-07T22:35:00Z,106.9239730834961
MetricBase-Zeitreihe – POST /now/clotho/put
Fügt Zeitreihendaten zu hinzu MetricBase Datenbank.
URL-Format
Versionierte URL: /api/now/{api_Version}/clotho/put
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| sysparm_ignore_unknown_series | Kennzeichnung, die angibt, ob unbekannte Serien ignoriert und die Transaktion fortgesetzt werden soll, ohne einen Fehler zurückzugeben. Gültige Werte:
Standardwert: wahr |
| Name | Beschreibung |
|---|---|
| SerienRef | Erforderlich. Zu aktualisierende Informationen. Datentyp: Array von Objekten |
| SeriesRef.metrik | Erforderlich. Name der zu aktualisierenden Metrik. Datentyp: Zeichenfolge |
| SeriesRef.Betreff | Erforderlich. SYS_ID des Datensatzes, in dem die Daten aktualisiert werden sollen. Datentyp: Zeichenfolge Tabelle: Angegeben in seriesRef.tableParameter. |
| SeriesRef.table | Erforderlich. Name der Tabelle, in der die Daten gespeichert werden sollen. Datentyp: Zeichenfolge |
| Werte | Erforderlich. Zu speichernde Serienwerte. Datentyp: Array |
| Werte.Zeitstempel | Erforderlich. ISO 8601-Zeitstempel des Werts. Datentyp: Zeichenfolge Format: Die Endung „Z“, die die UTC-Zeitzone in einem ISO-formatierten Zeitstempel angibt, ist optional. |
| Werte.Wert | Erforderlich. Metrikwert. Datentyp: Zahl |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Inhaltstyp | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
| Header | 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 .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Nachricht | Nachricht, die den Status der Anforderung angibt, z. B. ok Wenn die Anforderung erfolgreich verarbeitet wurde. |
cURL-Anforderung
curl "https://instance.servicenow.com/api/now/v1/clotho/put" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"seriesRef\": {
\"subject\": \"3D666b051787333200a328c5b836cb0b92\",
\"table\": \"mb_demo_drone\",
\"metric\": \"mb_demo_mt_altitude\"
},
\"values\": [
{
\"timestamp\": \"2019-03-21T17:05:00Z\",
\"value\": 0.150185
},
{
\"timestamp\": \"2019-03-21T17:06:00Z\",
\"value\": 0.46074
},
{
\"timestamp\": \"2019-03-21T17:07:00Z\",
\"value\": 0.83104
},
{
\"timestamp\": \"2019-03-21T17:08:00Z\",
\"value\": 1.260635
},
{
\"timestamp\": \"2019-03-21T17:09:00Z\",
\"value\": 1.749
}
]
}" \
--user "username":"password"
{
"result": {
"message": "ok"
}
}