PUT Persönliche Kennzahlen speichern
/api/v1/devices/{id}/summary-metrics
Wählen Sie für Ihre persönliche Ansicht dieses Monitors ein bis vier geordnete Kennzahlen oder konfigurierte Messreihen. Listen zeigen alle Werte, Übersichtskarten die ersten drei. Leserechte genügen. Erfassung und gemeinsame Monitoreinstellungen bleiben erhalten. GET durchsucht konfigurierte Messreihen mit q (höchstens 128 Zeichen), liefert bis zu 50 Reihen je Seite und zusätzliche Zusammenfassungen auf der ersten Seite; next_cursor setzt die Auswahl fort. Stabile Bezüge beginnen mit summary:, check: oder series:. Fehlende oder deaktivierte gespeicherte Quellen behalten einen nicht verfügbaren Platz. PUT und DELETE benötigen expected_revision und Idempotency-Key; Konflikte ergeben 409. DELETE stellt die automatische Auswahl wieder her. Nur für Browsersitzungen.
Auf dieser Seite
Zugriff und Rechte
Wählen Sie für Ihre persönliche Ansicht dieses Monitors ein bis vier geordnete Kennzahlen oder konfigurierte Messreihen. Listen zeigen alle Werte, Übersichtskarten die ersten drei. Leserechte genügen. Erfassung und gemeinsame Monitoreinstellungen bleiben erhalten. GET durchsucht konfigurierte Messreihen mit q (höchstens 128 Zeichen), liefert bis zu 50 Reihen je Seite und zusätzliche Zusammenfassungen auf der ersten Seite; next_cursor setzt die Auswahl fort. Stabile Bezüge beginnen mit summary:, check: oder series:. Fehlende oder deaktivierte gespeicherte Quellen behalten einen nicht verfügbaren Platz. PUT und DELETE benötigen expected_revision und Idempotency-Key; Konflikte ergeben 409. DELETE stellt die automatische Auswahl wieder her. Nur für Browsersitzungen.
Browsersitzung: Cookie __Host-mb_session.
Senden Sie bei einer Änderung mit Browsersitzung das aktuelle CSRF-Token in X-CSRF-Token zusammen mit dem Same-Site-Cookie. OAuth-Zustimmung verwendet ihr dokumentiertes Formularfeld.
Parameter und Header
| Feld | Position | Typ und Grenzen | Erforderlich | Bedeutung |
|---|---|---|---|---|
| id | Pfad | string; {"format":"uuid"} | Ja | Ressourcen-UUID aus dem Pfad. Sie muss existieren und für die handelnde Identität zugänglich sein. |
| Idempotency-Key | Header | string; {"minLength":16,"maxLength":128} | Ja | Speichern Sie vor der Anfrage eine Kennung und verwenden Sie sie nur für dieselbe normalisierte Nutzlast und Ressource erneut. Wiederverwendung mit anderem Inhalt liefert 409. |
Anfragekörper
| Feld | Typ und Grenzen | Erforderlich | Bedeutung |
|---|---|---|---|
| $ | object; {"additionalProperties":false} | Ja | — |
| $.expected_revision | integer; {"minimum":0} | Ja | Aktuelle Reihenfolgenrevision. Beim Verschieben oder Zurücksetzen als expected_revision übergeben; eine zwischenzeitliche Änderung liefert 409. |
| $.refs | array<string; {"pattern":"^(summary|check|series):.+$"}>; {"minItems":1,"maxItems":4} | Ja | — |
| $.refs[] | string; {"pattern":"^(summary|check|series):.+$"} | Ja | — |
Antworten
application/json
| Feld | Typ und Grenzen | Erforderlich | Bedeutung |
|---|---|---|---|
| $ | object; {"additionalProperties":false} | Ja | — |
| $.revision | integer; {"minimum":0} | Ja | — |
| $.custom | boolean | Ja | — |
| $.selection | array<object; {"additionalProperties":true}>; {"maxItems":4} | Ja | — |
| $.selection[] | object; {"additionalProperties":true} | Ja | — |
| $.selection[].ref | string | Ja | — |
| $.selection[].key | string | Ja | — |
| $.selection[].name | string | Nein | — |
| $.selection[].unit | string | Ja | — |
| $.selection[].value | number | string | null | Ja | — |
| $.selection[].freshness | string | Ja | — |
| $.selection[].sources | array<object> | Ja | — |
| $.selection[].sources[] | object | Ja | — |
| $.recommended | array<object; {"additionalProperties":true}>; {"maxItems":4} | Ja | — |
| $.recommended[] | object; {"additionalProperties":true} | Ja | — |
| $.recommended[].ref | string | Ja | — |
| $.recommended[].key | string | Ja | — |
| $.recommended[].name | string | Nein | — |
| $.recommended[].unit | string | Ja | — |
| $.recommended[].value | number | string | null | Ja | — |
| $.recommended[].freshness | string | Ja | — |
| $.recommended[].sources | array<object> | Ja | — |
| $.recommended[].sources[] | object | Ja | — |
| $.options | array<object; {"additionalProperties":true}> | Ja | — |
| $.options[] | object; {"additionalProperties":true} | Ja | — |
| $.options[].ref | string | Ja | — |
| $.options[].key | string | Ja | — |
| $.options[].name | string | Nein | — |
| $.options[].unit | string | Ja | — |
| $.options[].value | number | string | null | Ja | — |
| $.options[].freshness | string | Ja | — |
| $.options[].sources | array<object> | Ja | — |
| $.options[].sources[] | object | Ja | — |
| $.next_cursor | string | Ja | — |
| Stabile Fehlercodes |
|---|
| unauthorized |
application/problem+json
| Feld | Typ und Grenzen | Erforderlich | Bedeutung |
|---|---|---|---|
| $ | Problem | Ja | — |
| $.code | string | Ja | Stabiler maschinenlesbarer Fehlercode |
| $.detail | string | Ja | Kurze lokalisierte Erklärung ohne interne Fehlerdaten |
| $.instance | string | Ja | Einmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource |
| $.message | string | Ja | Vorübergehend für bestehende Clients gleich detail |
| $.message_key | string | Ja | Stabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage |
| $.message_params | object; {"additionalProperties":true} | Ja | Benannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Ja | Vom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten. |
| $.status | integer; {"maximum":599,"minimum":400} | Ja | — |
| $.title | string | Ja | Lokalisierte HTTP-Statusbezeichnung |
| $.type | string; {"const":"about:blank"} | Ja | — |
| $.limit | integer | string | Nein | Der Ressourcenschutz antwortet mit HTTP 429, Retry-After, Grenzkennung und Geltungsbereich. Erst nach der Wartezeit wiederholen; bei Telemetrie IDs und Inhalte erhalten. Abgewiesene Telemetrieblöcke werden atomar behandelt. |
| $.scope | string; {"enum":["owner","actor","free_pool","platform","capacity","network"]} | Nein | — |
| $.field_errors | array<object>; {"maxItems":64} | Nein | — |
| $.field_errors[] | object | Ja | — |
| $.field_errors[].path | string; {"maxLength":256} | Ja | — |
| $.field_errors[].message_key | string | Ja | — |
| $.field_errors[].message_params | object; {"additionalProperties":true} | Nein | — |
| Stabile Fehlercodes |
|---|
| browser_session_required |
| forbidden |
| csrf |
| invalid_origin |
| workspace_scope |
application/problem+json
| Feld | Typ und Grenzen | Erforderlich | Bedeutung |
|---|---|---|---|
| $ | Problem | Ja | — |
| $.code | string | Ja | Stabiler maschinenlesbarer Fehlercode |
| $.detail | string | Ja | Kurze lokalisierte Erklärung ohne interne Fehlerdaten |
| $.instance | string | Ja | Einmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource |
| $.message | string | Ja | Vorübergehend für bestehende Clients gleich detail |
| $.message_key | string | Ja | Stabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage |
| $.message_params | object; {"additionalProperties":true} | Ja | Benannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Ja | Vom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten. |
| $.status | integer; {"maximum":599,"minimum":400} | Ja | — |
| $.title | string | Ja | Lokalisierte HTTP-Statusbezeichnung |
| $.type | string; {"const":"about:blank"} | Ja | — |
| $.limit | integer | string | Nein | Der Ressourcenschutz antwortet mit HTTP 429, Retry-After, Grenzkennung und Geltungsbereich. Erst nach der Wartezeit wiederholen; bei Telemetrie IDs und Inhalte erhalten. Abgewiesene Telemetrieblöcke werden atomar behandelt. |
| $.scope | string; {"enum":["owner","actor","free_pool","platform","capacity","network"]} | Nein | — |
| $.field_errors | array<object>; {"maxItems":64} | Nein | — |
| $.field_errors[] | object | Ja | — |
| $.field_errors[].path | string; {"maxLength":256} | Ja | — |
| $.field_errors[].message_key | string | Ja | — |
| $.field_errors[].message_params | object; {"additionalProperties":true} | Nein | — |
| Stabile Fehlercodes |
|---|
| not_found |
application/problem+json
| Feld | Typ und Grenzen | Erforderlich | Bedeutung |
|---|---|---|---|
| $ | Problem | Ja | — |
| $.code | string | Ja | Stabiler maschinenlesbarer Fehlercode |
| $.detail | string | Ja | Kurze lokalisierte Erklärung ohne interne Fehlerdaten |
| $.instance | string | Ja | Einmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource |
| $.message | string | Ja | Vorübergehend für bestehende Clients gleich detail |
| $.message_key | string | Ja | Stabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage |
| $.message_params | object; {"additionalProperties":true} | Ja | Benannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Ja | Vom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten. |
| $.status | integer; {"maximum":599,"minimum":400} | Ja | — |
| $.title | string | Ja | Lokalisierte HTTP-Statusbezeichnung |
| $.type | string; {"const":"about:blank"} | Ja | — |
| $.limit | integer | string | Nein | Der Ressourcenschutz antwortet mit HTTP 429, Retry-After, Grenzkennung und Geltungsbereich. Erst nach der Wartezeit wiederholen; bei Telemetrie IDs und Inhalte erhalten. Abgewiesene Telemetrieblöcke werden atomar behandelt. |
| $.scope | string; {"enum":["owner","actor","free_pool","platform","capacity","network"]} | Nein | — |
| $.field_errors | array<object>; {"maxItems":64} | Nein | — |
| $.field_errors[] | object | Ja | — |
| $.field_errors[].path | string; {"maxLength":256} | Ja | — |
| $.field_errors[].message_key | string | Ja | — |
| $.field_errors[].message_params | object; {"additionalProperties":true} | Nein | — |
| Stabile Fehlercodes |
|---|
| revision_conflict |
| idempotency_conflict |
application/problem+json
| Feld | Typ und Grenzen | Erforderlich | Bedeutung |
|---|---|---|---|
| $ | Problem | Ja | — |
| $.code | string | Ja | Stabiler maschinenlesbarer Fehlercode |
| $.detail | string | Ja | Kurze lokalisierte Erklärung ohne interne Fehlerdaten |
| $.instance | string | Ja | Einmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource |
| $.message | string | Ja | Vorübergehend für bestehende Clients gleich detail |
| $.message_key | string | Ja | Stabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage |
| $.message_params | object; {"additionalProperties":true} | Ja | Benannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Ja | Vom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten. |
| $.status | integer; {"maximum":599,"minimum":400} | Ja | — |
| $.title | string | Ja | Lokalisierte HTTP-Statusbezeichnung |
| $.type | string; {"const":"about:blank"} | Ja | — |
| $.limit | integer | string | Nein | Der Ressourcenschutz antwortet mit HTTP 429, Retry-After, Grenzkennung und Geltungsbereich. Erst nach der Wartezeit wiederholen; bei Telemetrie IDs und Inhalte erhalten. Abgewiesene Telemetrieblöcke werden atomar behandelt. |
| $.scope | string; {"enum":["owner","actor","free_pool","platform","capacity","network"]} | Nein | — |
| $.field_errors | array<object>; {"maxItems":64} | Nein | — |
| $.field_errors[] | object | Ja | — |
| $.field_errors[].path | string; {"maxLength":256} | Ja | — |
| $.field_errors[].message_key | string | Ja | — |
| $.field_errors[].message_params | object; {"additionalProperties":true} | Nein | — |
| Stabile Fehlercodes |
|---|
| invalid_input |
| invalid_device |
| invalid_reference |
| invalid_idempotency_key |
application/problem+json
| Feld | Typ und Grenzen | Erforderlich | Bedeutung |
|---|---|---|---|
| $ | Problem | Ja | — |
| $.code | string | Ja | Stabiler maschinenlesbarer Fehlercode |
| $.detail | string | Ja | Kurze lokalisierte Erklärung ohne interne Fehlerdaten |
| $.instance | string | Ja | Einmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource |
| $.message | string | Ja | Vorübergehend für bestehende Clients gleich detail |
| $.message_key | string | Ja | Stabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage |
| $.message_params | object; {"additionalProperties":true} | Ja | Benannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Ja | Vom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten. |
| $.status | integer; {"maximum":599,"minimum":400} | Ja | — |
| $.title | string | Ja | Lokalisierte HTTP-Statusbezeichnung |
| $.type | string; {"const":"about:blank"} | Ja | — |
| $.limit | integer | string | Nein | Der Ressourcenschutz antwortet mit HTTP 429, Retry-After, Grenzkennung und Geltungsbereich. Erst nach der Wartezeit wiederholen; bei Telemetrie IDs und Inhalte erhalten. Abgewiesene Telemetrieblöcke werden atomar behandelt. |
| $.scope | string; {"enum":["owner","actor","free_pool","platform","capacity","network"]} | Nein | — |
| $.field_errors | array<object>; {"maxItems":64} | Nein | — |
| $.field_errors[] | object | Ja | — |
| $.field_errors[].path | string; {"maxLength":256} | Ja | — |
| $.field_errors[].message_key | string | Ja | — |
| $.field_errors[].message_params | object; {"additionalProperties":true} | Nein | — |
| Stabile Fehlercodes |
|---|
| unavailable |
application/problem+json
| Feld | Typ und Grenzen | Erforderlich | Bedeutung |
|---|---|---|---|
| $ | Problem | Ja | — |
| $.code | string | Ja | Stabiler maschinenlesbarer Fehlercode |
| $.detail | string | Ja | Kurze lokalisierte Erklärung ohne interne Fehlerdaten |
| $.instance | string | Ja | Einmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource |
| $.message | string | Ja | Vorübergehend für bestehende Clients gleich detail |
| $.message_key | string | Ja | Stabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage |
| $.message_params | object; {"additionalProperties":true} | Ja | Benannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Ja | Vom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten. |
| $.status | integer; {"maximum":599,"minimum":400} | Ja | — |
| $.title | string | Ja | Lokalisierte HTTP-Statusbezeichnung |
| $.type | string; {"const":"about:blank"} | Ja | — |
| $.limit | integer | string | Nein | Der Ressourcenschutz antwortet mit HTTP 429, Retry-After, Grenzkennung und Geltungsbereich. Erst nach der Wartezeit wiederholen; bei Telemetrie IDs und Inhalte erhalten. Abgewiesene Telemetrieblöcke werden atomar behandelt. |
| $.scope | string; {"enum":["owner","actor","free_pool","platform","capacity","network"]} | Nein | — |
| $.field_errors | array<object>; {"maxItems":64} | Nein | — |
| $.field_errors[] | object | Ja | — |
| $.field_errors[].path | string; {"maxLength":256} | Ja | — |
| $.field_errors[].message_key | string | Ja | — |
| $.field_errors[].message_params | object; {"additionalProperties":true} | Nein | — |
Wiederholungen und asynchrone Aufträge
Für diese Änderung gibt es keine allgemeine Wiederholungsgarantie. Prüfen Sie bei unklarer Antwort den betroffenen Eintrag, bevor Sie es erneut versuchen. Beachten Sie Wartezeiten aus Retry-After und fordern Sie abgelaufene Anmelde- oder Aktionscodes neu an.
Anfragebeispiele
Ersetzen Sie Demokennungen, Zeitstempel und Platzhalter durch eigene Werte. Behalten Sie bei Wiederholungen Kennungen, Zeit und Inhalt bei. Diese Beispiele führen auf der Seite keine Anfragen aus.
Halten Sie Anmeldelinks, Codes, Cookies und Schlüssel privat. Schreiben Sie sie nicht in Logs und teilen Sie sie nicht in Hilfeanfragen.
curl --request PUT --header "Cookie: $MB_COOKIE" --header "X-CSRF-Token: $MB_CSRF" --header "Idempotency-Key: $MB_OPERATION_ID" --header "Content-Type: application/json" --data '{"expected_revision":0,"refs":["summary:active_series"]}' "https://metribeacon.com/api/v1/devices/00000000-0000-4000-8000-000000000001/summary-metrics"
import json, os, urllib.request
headers = {"Cookie": os.environ["MB_COOKIE"], "X-CSRF-Token": os.environ["MB_CSRF"], "Content-Type": "application/json"}
headers["Idempotency-Key"] = os.environ["MB_OPERATION_ID"]
request = urllib.request.Request("https://metribeacon.com/api/v1/devices/00000000-0000-4000-8000-000000000001/summary-metrics", method="PUT", headers=headers, data='{"expected_revision":0,"refs":["summary:active_series"]}'.encode())
with urllib.request.urlopen(request, timeout=30) as response:
print(json.load(response))
const response = await fetch("https://metribeacon.com/api/v1/devices/00000000-0000-4000-8000-000000000001/summary-metrics", {method: "PUT", credentials: "same-origin", headers: {"Content-Type":"application/json", "X-CSRF-Token":csrfToken, "Idempotency-Key":operationId}, body:JSON.stringify({"expected_revision":0,"refs":["summary:active_series"]})});
console.log(response.status, await response.json());
package main
import ("fmt"; "net/http"; "os"; "strings"; "time")
func main() {
client := &http.Client{Timeout:30*time.Second}
request, err := http.NewRequest("PUT","https://metribeacon.com/api/v1/devices/00000000-0000-4000-8000-000000000001/summary-metrics",strings.NewReader("{\"expected_revision\":0,\"refs\":[\"summary:active_series\"]}"))
if err != nil { panic(err) }
request.Header.Set("Cookie",os.Getenv("MB_COOKIE"))
request.Header.Set("X-CSRF-Token",os.Getenv("MB_CSRF"))
request.Header.Set("Content-Type","application/json")
request.Header.Set("Idempotency-Key",os.Getenv("MB_OPERATION_ID"))
response,err := client.Do(request)
if err != nil {panic(err)}
defer response.Body.Close()
fmt.Println(response.StatusCode)
}