Ressourcenoperationen

Jede Art von Datensatz ist ein eigener Befehl, etwa incident, monitor oder status-page, und jeder nimmt dieselben Operationen: list, get, create, update, delete und count. Diese Seite zeigt jede Operation, mit Filtern, Seiten und dem JSON, in dem ein Datensatz geschrieben wird.

Wie die Operationen zusammenspielen#

Lesen, Ändern und Löschen eines Datensatzes brauchen seine ID. Auflisten, Zählen und Erstellen brauchen keine, und eine Liste oder ein Erstellen liefert Ihnen die IDs, die die anderen nehmen:

Eine ID ist eine UUID, etwa 6f1c2a40-3b1e-4c55-9a0b-3e2f8d7c1a11. Sie können eine auch auf der Seite des Datensatzes in Status200 kopieren: siehe Die ID einer Ressource finden.

Den Befehl für einen Datensatz finden#

status200 resources

Die Liste zeigt jede Art von Datensatz mit ihrem Befehl, ihren Namen, ihrem Typ und ihrem API-Pfad. Es gibt zwei Typen:

Zeigen Sie einen Typ mit status200 resources --type database oder --type analytics. Die Befehlsreferenz listet jeden Befehl auf.

Datensätze auflisten#

status200 <resource> list [--query <json>] [--limit <n>] [--skip <n>] [--sort <json>] [-o <format>]

# The ten newest incidents
status200 incident list

# The oldest monitors first, 50 at a time: the second page
status200 monitor list --sort '{"createdAt":"ASC"}' --limit 50 --skip 50

# Every field of each incident, as JSON
status200 incident list -o json

Eine Liste fragt Status200 nach jedem Feld jedes Datensatzes, das der Schlüssel lesen darf. Eine Tabelle zeigt sechs davon; JSON zeigt sie alle (siehe Ausgabeformate). Um durch alle Datensätze zu blättern, erhöhen Sie --skip um --limit, bis eine Seite leer zurückkommt; count sagt, wie viele es gibt.

Beschriftungen werden nach Namen statt mit den neuesten zuerst aufgelistet: Beschriftungen, deren Namen mit einer Zahl beginnen, kommen zuerst, in der Reihenfolge dieser Zahl (2. Team vor 10. Owner), danach die übrigen alphabetisch. Für eine andere Reihenfolge geben Sie --sort an.

Eine Liste filtern#

--query nimmt denselben Filter wie die API: Ein Feld mit einem Wert passt zu diesem Wert, und ein Objekt mit einem _type vergleicht.

status200 incident list --query '{"title":{"_type":"Search","value":"checkout"}}'

Filtern, sortieren und blättern in der API-Referenz listet jeden _type auf.

Einen Datensatz lesen#

status200 <resource> get <id> [-o <format>]

status200 incident get 6f1c2a40-3b1e-4c55-9a0b-3e2f8d7c1a11

Eine Tabelle zeigt eine Zeile für jedes Feld des Datensatzes, jeden Wert nach 60 Zeichen abgeschnitten; -o json zeigt die Werte vollständig. Eine ID, die keinen Datensatz nennt, den Ihr Schlüssel lesen darf, antwortet mit Not found, und der Befehl endet mit dem Code 3.

Einen Datensatz erstellen#

status200 <resource> create --data <json> [-o <format>]
status200 <resource> create --file <path> [-o <format>]

--data nimmt den Datensatz als JSON, und --file liest ihn aus einer JSON-Datei. Geben Sie eines von beiden an; sind beide angegeben, wird die Datei verwendet. Die Felder sind die der API, und die API-Referenz listet die jeder Ressource auf. Das Projekt kommt aus dem API-Schlüssel, ein Datensatz nennt es also nie.

# A manual monitor
status200 monitor create --data '{"name":"Checkout API","monitorType":"Manual"}'

# An incident with one of your severities
status200 incident create --data '{"title":"Checkout API is down","incidentSeverityId":"<severity-id>"}'

# The same incident, from a file
status200 incident create --file incident.json

Die CLI gibt den neuen Datensatz mit seiner _id aus. Ein Vorfall beginnt im Erstellt-Status Ihres Projekts, es sei denn, currentIncidentStateId nennt einen anderen: siehe Der Status, in dem ein neuer Datensatz beginnt. So finden Sie die IDs Ihrer Schweregrade:

status200 incident-severity list -o json | jq -r '.[] | "\(._id)  \(.name)"'

Einen Datensatz aktualisieren#

status200 <resource> update <id> --data <json> [-o <format>]

--data ist Pflicht und enthält nur die zu ändernden Felder:

# Rename a monitor
status200 monitor update <monitor-id> --data '{"name":"Checkout API (EU)"}'

# Move an incident to your resolved state
status200 incident update <incident-id> --data '{"currentIncidentStateId":"<resolved-state-id>"}'

Status200 beantwortet eine Aktualisierung mit einem leeren Objekt: Die CLI gibt eine leere Zeile aus, oder {} mit -o json. Führen Sie get aus, um den Datensatz in seinem jetzigen Stand zu sehen. Wird ein Vorfall auf diesem Weg in einen anderen Status versetzt, wird die Änderung in seinem Verlauf festgehalten, wie im Dashboard, und ein Status vor seinem aktuellen wird abgelehnt. So finden Sie die ID des Gelöst-Status, des ersten in der Reihenfolge Ihres Projekts:

status200 incident-state list --query '{"isResolvedState":true}' --sort '{"order":"ASC"}' --limit 1 -o json | jq -r '.[0]._id'

Einen Datensatz löschen#

status200 <resource> delete <id>

status200 monitor delete 6f1c2a40-3b1e-4c55-9a0b-3e2f8d7c1a11

Sie antwortet Monitor 6f1c2a40-3b1e-4c55-9a0b-3e2f8d7c1a11 deleted successfully.

Datensätze zählen#

status200 <resource> count [--query <json>]

# Every incident
status200 incident count

# Incidents that are not resolved
status200 incident count --query '{"currentIncidentState":{"isResolvedState":false}}'

Die CLI gibt eine Zahl aus, in einer Tabelle wie in JSON dieselbe, sodass ein Skript sie so lesen kann, wie sie ist.

Was jeder Typ kann#

Fehlerbehebung#

Nächste Schritte#