GET API: Eigene Hintergrundaufträge auflisten
/api/v1/workspaces/{id}/background-jobs
Listen Sie eigene CSV-Exporte, fortgesetzte Historienabfragen und aktuelle Verfügbarkeitsauswertungen oder Berichte eines Arbeitsbereichs auf. Mitgliedschaft und Aufbewahrung gelten auch für Ergebnisse.
Auf dieser Seite
Zugriff und Rechte
Listen Sie eigene CSV-Exporte, fortgesetzte Historienabfragen und aktuelle Verfügbarkeitsauswertungen oder Berichte eines Arbeitsbereichs auf. Mitgliedschaft und Aufbewahrung gelten auch für Ergebnisse.
Browsersitzung: Cookie __Host-mb_session.
Maschinen-Verwaltungszugang in Authorization: Bearer. Beachten Sie die von der Operation benötigten Berechtigungen (Scopes).
Parameter und Header
| Feld | Position | Typ und Grenzen | Erforderlich | Bedeutung |
|---|---|---|---|---|
| id | Pfad | string; {"format":"uuid"} | Ja | Ressourcen-ID in diesem Arbeitsbereich |
| table | URL-Parameter | string; {"enum":["1"]} | Nein | Für eine gefilterte Cursor-Seite auf 1 setzen; ohne Tabellenparameter bleibt die ursprüngliche Antwort erhalten. |
| q | URL-Parameter | string; {"maxLength":128} | Nein | Suche nach wörtlichem Text ohne Beachtung der Groß-/Kleinschreibung in den dokumentierten Textfeldern, vor dem Seitenlimit. |
| limit | URL-Parameter | integer; {"default":50,"maximum":100,"minimum":1} | Nein | Seitengröße 1–100, standardmäßig 50. Eine Folgeseite besteht nur bei einer weiteren passenden Zeile. |
| cursor | URL-Parameter | string; {"maxLength":4096} | Nein | Opaker next_cursor der vorherigen Seite. Ressource, Konto, Filter, Sortierung und Limit beibehalten; Listen-Cursor verfallen nach 15 Minuten. |
| sort | URL-Parameter | string; {"enum":["newest","oldest","name_asc","name_desc"]} | Nein | Stabile Sortierung mit der Datensatz-ID bei Gleichstand: newest, oldest, name_asc oder name_desc. |
| status | URL-Parameter | string; {"enum":["queued","running","complete","failed","cancelled"]} | Nein | Exakter Feldfilter; Parameter für alle Werte weglassen. |
| kind | URL-Parameter | string | Nein | Exakter Feldfilter; Parameter für alle Werte weglassen. |
| job | URL-Parameter | string; {"pattern":"^(archive|analysis):[a-fA-F0-9-]{36}$"} | Nein | Öffnen Sie einen eigenen Auftrag anhand seiner Zeilenkennung. |
| counts_only | URL-Parameter | string; {"enum":["1"]} | Nein | Liefert Anzahlen für den angegebenen Filter statt Tabellenzeilen. Suche und weitere Filter gelten; die eigene Auswahl, Sortierung und Pagination beeinflussen die Zählung nicht. |
| count_filter | URL-Parameter | string; {"enum":["status","kind"]} | Nein | Deklarierter Tabellenfilter für die Zählung. Erfordert counts_only=1. |
| snapshot | URL-Parameter | string; {"format":"date-time"} | Nein | Optionaler Snapshot der zugehörigen Tabellenseite. |
Anfragekörper
Kein Anfragekörper.
Antworten
application/json
| Feld | Typ und Grenzen | Erforderlich | Bedeutung |
|---|---|---|---|
| $ | object | object | Ja | — |
| $ (anyOf 1) | object | Nein | — |
| $ (anyOf 1).jobs | array<object> | Ja | — |
| $ (anyOf 1).jobs[] | object | Ja | — |
| $ (anyOf 1).jobs[].row_key | string | Ja | — |
| $ (anyOf 1).jobs[].id | string | Ja | — |
| $ (anyOf 1).jobs[].workspace_id | string | Ja | — |
| $ (anyOf 1).jobs[].name | string | Ja | — |
| $ (anyOf 1).jobs[].resolution | string | Ja | — |
| $ (anyOf 1).jobs[].from_time | string; {"format":"date-time"} | Ja | — |
| $ (anyOf 1).jobs[].to_time | string; {"format":"date-time"} | Ja | — |
| $ (anyOf 1).jobs[].created_at | string; {"format":"date-time"} | Ja | — |
| $ (anyOf 1).jobs[].expires_at | string; {"format":"date-time"} | Ja | — |
| $ (anyOf 1).jobs[].series_id | string | null; {"format":"uuid"} | Ja | — |
| $ (anyOf 1).jobs[].device_id | string | null; {"format":"uuid"} | Ja | — |
| $ (anyOf 1).jobs[].background | boolean | Ja | — |
| $ (anyOf 1).jobs[].can_cancel | boolean | Ja | — |
| $ (anyOf 1).jobs[].result_available | boolean | Ja | — |
| $ (anyOf 1).jobs[].kind | string; {"enum":["export","history","slo","report","log_export"]} | Ja | — |
| $ (anyOf 1).jobs[].status | string; {"enum":["queued","running","complete","failed","cancelled"]} | Ja | — |
| $ (anyOf 1).jobs[].completed_at | string; {"format":"date-time"} | null | Nein | — |
| $ (anyOf 1).jobs[].completed_at (anyOf 1) | string; {"format":"date-time"} | Nein | — |
| $ (anyOf 1).jobs[].completed_at (anyOf 2) | null | Nein | — |
| $ (anyOf 1).jobs[].unread | boolean | Nein | — |
| $ (anyOf 1).jobs[].notified | boolean | Nein | — |
| $ (anyOf 1).jobs[].can_retry | boolean | Nein | — |
| $ (anyOf 1).jobs[].error_code | string | null | Nein | — |
| $ (anyOf 1).jobs[].format | string | null; {"enum":["csv","ndjson",null]} | Nein | — |
| $ (anyOf 1).active_count | integer; {"minimum":0} | Ja | — |
| $ (anyOf 1).limit | integer; {"minimum":1,"maximum":100} | Ja | — |
| $ (anyOf 1).next_cursor | string | Ja | — |
| $ (anyOf 1).snapshot | string; {"format":"date-time"} | Ja | — |
| $ (anyOf 1).unread_count | integer; {"minimum":0} | Nein | — |
| $ (anyOf 2) | object | Nein | — |
| $ (anyOf 2).filter_counts | TableFilterCounts | Ja | — |
| $ (anyOf 2).filter_counts.field | string | Ja | — |
| $ (anyOf 2).filter_counts.total | integer; {"minimum":0} | Ja | — |
| $ (anyOf 2).filter_counts.values | object | Ja | — |
| $ (anyOf 2).filter_counts.complete | boolean | Ja | — |
| $ (anyOf 2).filter_counts.snapshot | string; {"format":"date-time"} | Ja | — |
| $ (anyOf 2).filter_counts.counted_at | string; {"format":"date-time"} | Ja | — |
| Stabile Fehlercodes |
|---|
| invalid_session |
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 | — |
| Stabile Fehlercodes |
|---|
| csrf |
| forbidden |
| insufficient_scope |
| owner_required |
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 | — |
| 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 | — |
| Stabile Fehlercodes |
|---|
| idempotency_conflict |
| job_not_active |
| job_not_ready |
| revision_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 | — |
| Stabile Fehlercodes |
|---|
| invalid_idempotency_key |
| invalid_report |
| invalid_slo |
| invalid_workspace |
| invalid_job |
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 | — |
| Stabile Fehlercodes |
|---|
| alarm_limit |
| analysis_capacity |
| report_limit |
| slo_limit |
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 | — |
| 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 | — |
Wiederholungen und asynchrone Aufträge
Diese Operation liest oder prüft, ohne eine Ressourcenänderung anzuwenden. Beachten Sie Ratenlimits und Zugangslaufzeiten.
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 --silent --show-error --output /dev/null --write-out "%{http_code}\n" --request GET --header @"$HOME/.config/metribeacon/headers.txt" "https://metribeacon.com/api/v1/workspaces/00000000-0000-4000-8000-000000000001/background-jobs"
import json
from pathlib import Path
from urllib.request import Request, HTTPRedirectHandler, build_opener
from urllib.error import HTTPError
headers=json.loads((Path.home()/".config/metribeacon/headers.json").read_text())
class NoRedirect(HTTPRedirectHandler):
def redirect_request(self, request, fp, code, message, headers, target): return None
request=Request('https://metribeacon.com/api/v1/workspaces/00000000-0000-4000-8000-000000000001/background-jobs',data=None,headers=headers,method='GET')
try:
with build_opener(NoRedirect()).open(request,timeout=10) as response: print(response.status)
except HTTPError as error:
print(error.code)
error.close()
import {readFile} from "node:fs/promises";
import {homedir} from "node:os";
import {join} from "node:path";
const headers=JSON.parse(await readFile(join(homedir(),".config/metribeacon/headers.json"),"utf8"));
const response=await fetch("https://metribeacon.com/api/v1/workspaces/00000000-0000-4000-8000-000000000001/background-jobs",{method:"GET",headers,redirect:"manual",signal:AbortSignal.timeout(10000)});
console.log(response.status);await response.body?.cancel();
package main
import("encoding/json";"fmt";"net/http";"os";"path/filepath";"time")
func main(){home,e:=os.UserHomeDir();if e!=nil{return};raw,e:=os.ReadFile(filepath.Join(home,".config/metribeacon/headers.json"));if e!=nil{return};var headers map[string]string;if json.Unmarshal(raw,&headers)!=nil{return};req,e:=http.NewRequest("GET","https://metribeacon.com/api/v1/workspaces/00000000-0000-4000-8000-000000000001/background-jobs",nil);if e!=nil{return};for k,v:=range headers{req.Header.Set(k,v)};client:=&http.Client{Timeout:10*time.Second,CheckRedirect:func(*http.Request,[]*http.Request)error{return http.ErrUseLastResponse}};res,e:=client.Do(req);if e!=nil{return};defer res.Body.Close();fmt.Println(res.StatusCode)}
Verwandte Anleitungen
- HTTP-API, OAuth und MCP
Finden Sie die Nutzer-API-Endpunkte mit Rechten, Feldern, Beispielen und Antwortformaten.
- GET Berichtpläne auflisten
Arbeitsbereichs-SLOs verwenden die Gesamtverfügbarkeitsreihe von HTTP-, TCP-, UDP-, DNS-, TLS-, Ping-, Dienst-, Domain- und Browsermonitoren. Unbekannte und unbeobachtete Zeit bleiben ausdrücklich sichtbar; erst die untere Verfügbarkeitsgrenze belegt die Zielerfüllung. Je Arbeitsbereich gelten zehn SLOs und drei Berichtpläne. Kalenderberichte bleiben 90 Tage unveränderlich. E-Mail benötigt die ausdrückliche Freigabe des Owners sowie ein bestätigtes Ziel und teilt das vorhandene Zustellkontingent. Abbrechbare Analysejobs teilen vier globale Plätze und einen je Owner; Arbeitsbereichsgrenzen bleiben verbindlich. Wählen Sie tägliche, wöchentliche oder monatliche Berichte und eine Versandzeit (HH:MM) in einer IANA-Zeitzone. Der Bericht umfasst den vorigen lokalen Kalendertag, die vorige Woche von Montag bis Sonntag oder den vorigen Monat. Die Erstellung startet zur gewählten Zeit; die Zustellung kann später erfolgen. Bei der Zeitumstellung wird eine fehlende Uhrzeit auf die nächste gültige Minute verschoben und eine doppelte Uhrzeit nur einmal verwendet. Die manuelle Erstellung verwendet unabhängig von der Versandzeit den letzten abgeschlossenen Zeitraum.
- POST Berichtplan anlegen
Arbeitsbereichs-SLOs verwenden die Gesamtverfügbarkeitsreihe von HTTP-, TCP-, UDP-, DNS-, TLS-, Ping-, Dienst-, Domain- und Browsermonitoren. Unbekannte und unbeobachtete Zeit bleiben ausdrücklich sichtbar; erst die untere Verfügbarkeitsgrenze belegt die Zielerfüllung. Je Arbeitsbereich gelten zehn SLOs und drei Berichtpläne. Kalenderberichte bleiben 90 Tage unveränderlich. E-Mail benötigt die ausdrückliche Freigabe des Owners sowie ein bestätigtes Ziel und teilt das vorhandene Zustellkontingent. Abbrechbare Analysejobs teilen vier globale Plätze und einen je Owner; Arbeitsbereichsgrenzen bleiben verbindlich. Wählen Sie tägliche, wöchentliche oder monatliche Berichte und eine Versandzeit (HH:MM) in einer IANA-Zeitzone. Der Bericht umfasst den vorigen lokalen Kalendertag, die vorige Woche von Montag bis Sonntag oder den vorigen Monat. Die Erstellung startet zur gewählten Zeit; die Zustellung kann später erfolgen. Bei der Zeitumstellung wird eine fehlende Uhrzeit auf die nächste gültige Minute verschoben und eine doppelte Uhrzeit nur einmal verwendet. Die manuelle Erstellung verwendet unabhängig von der Versandzeit den letzten abgeschlossenen Zeitraum.
- GET Unveränderliche Arbeitsbereichsberichte auflisten
Arbeitsbereichs-SLOs verwenden die Gesamtverfügbarkeitsreihe von HTTP-, TCP-, UDP-, DNS-, TLS-, Ping-, Dienst-, Domain- und Browsermonitoren. Unbekannte und unbeobachtete Zeit bleiben ausdrücklich sichtbar; erst die untere Verfügbarkeitsgrenze belegt die Zielerfüllung. Je Arbeitsbereich gelten zehn SLOs und drei Berichtpläne. Kalenderberichte bleiben 90 Tage unveränderlich. E-Mail benötigt die ausdrückliche Freigabe des Owners sowie ein bestätigtes Ziel und teilt das vorhandene Zustellkontingent. Abbrechbare Analysejobs teilen vier globale Plätze und einen je Owner; Arbeitsbereichsgrenzen bleiben verbindlich. Wählen Sie tägliche, wöchentliche oder monatliche Berichte und eine Versandzeit (HH:MM) in einer IANA-Zeitzone. Der Bericht umfasst den vorigen lokalen Kalendertag, die vorige Woche von Montag bis Sonntag oder den vorigen Monat. Die Erstellung startet zur gewählten Zeit; die Zustellung kann später erfolgen. Bei der Zeitumstellung wird eine fehlende Uhrzeit auf die nächste gültige Minute verschoben und eine doppelte Uhrzeit nur einmal verwendet. Die manuelle Erstellung verwendet unabhängig von der Versandzeit den letzten abgeschlossenen Zeitraum.