Zum Inhalt springen
Dokumentation
Befehlsreferenz

Befehlsreferenz

Als Markdown anzeigen

Jeder Befehl der CLI status200, mit seinen Argumenten, Optionen und Standardwerten. Hängen Sie --help an einen Befehl, um dasselbe in Ihrem Terminal zu sehen.

Globale OptionenDie Optionen, die jeder Befehl nimmt.Anmeldung und Kontextelogin und die context-Befehle.Ressourcenbefehlelist, get, create, update, delete und count.Weitere Befehledeploy, whoami, resources, version und help.

Die Befehle

flowchart LR O["status200"] --> L["login"] O --> C["context"] C --> C1["list<br/>use<br/>current<br/>delete"] O --> R["incident, monitor<br/>und jede Ressource"] R --> R1["list<br/>get<br/>create<br/>update<br/>delete<br/>count"] O --> U["deploy<br/>whoami<br/>resources<br/>version<br/>help"]

Die Befehle der CLI status200

Globale Optionen

OptionWas sie tutStandard
--api-key <key>Der API-Schlüssel für diesen BefehlSTATUS200_API_KEY, dann der Schlüssel des Kontexts
--url <url>Die Adresse Ihrer Status200-Instanz für diesen BefehlSTATUS200_URL, dann die URL des Kontexts
--context <name>Der gespeicherte Kontext für diesen BefehlDer aktuelle Kontext
-o, --output <format>json, table oder widetable im Terminal, json in einer Pipe
--no-colorGibt ohne Farben ausFarben, außer NO_COLOR ist gesetzt
-V, --versionGibt die Version der CLI aus
-h, --helpZeigt die Hilfe eines Befehls

Die Optionen stehen vor oder hinter dem Befehl: status200 --context staging incident list und status200 incident list --context staging tun dasselbe.

Anmeldung und Kontexte

status200 login

Speichert einen API-Schlüssel und eine Adresse als Kontext und macht ihn zum aktuellen. Siehe Anmelden.

Bash 
status200 login <api-key> <instance-url> [--context-name <name>]
Argument oder OptionErforderlichWas es istStandard
<api-key>JaEin API-Schlüssel Ihres Projekts
<instance-url>JaDie Adresse Ihrer Status200-Instanz, etwa https://status200.ru
--context-name <name>NeinDer Name, unter dem der Kontext gespeichert wirddefault

status200 context list

Listet die gespeicherten Kontexte auf; * markiert den aktuellen. API-Schlüssel werden nie aufgelistet.

Bash 
status200 context list [-o <format>]
OptionErforderlichWas es ist
-o, --output <format>Neinjson, table oder wide. JSON liefert von jedem Kontext name, apiUrl und isCurrent

status200 context use

Macht einen gespeicherten Kontext zum aktuellen.

Bash 
status200 context use <name>
ArgumentErforderlichWas es ist
<name>JaDer Name eines gespeicherten Kontexts

status200 context current

Zeigt Namen und URL des aktuellen Kontexts und seinen API-Schlüssel, von dem alles außer den ersten vier und letzten vier Zeichen verborgen ist.

Bash 
status200 context current

status200 context delete

Löscht einen gespeicherten Kontext. War es der aktuelle, wird der erste verbleibende Kontext zum aktuellen.

Bash 
status200 context delete <name>
ArgumentErforderlichWas es ist
<name>JaDer Name eines gespeicherten Kontexts

Ressourcenbefehle

<resource> ist der Befehl einer Art von Datensatz aus den Tabellen unter Ressourcen, etwa incident oder monitor. Beispiele finden Sie unter Ressourcenoperationen.

status200 <resource> list

Listet Datensätze auf, die neuesten zuerst. Beschriftungen werden stattdessen nach Namen aufgelistet, nummerierte Beschriftungen zuerst (2. Team vor 10. Owner).

Bash 
status200 <resource> list [--query <json>] [--limit <n>] [--skip <n>] [--sort <json>] [-o <format>]
OptionWas sie tutStandard
--query <json>Ein Filter, als JSONJeder Datensatz, den der Schlüssel lesen darf
--limit <n>Die meisten zurückzugebenden Datensätze, bis zu 10.00010
--skip <n>Wie viele Datensätze zuerst übersprungen werden0
--sort <json>Die Reihenfolge, als JSON: {"<field>":"ASC"} oder {"<field>":"DESC"}Die neuesten zuerst
-o, --output <format>json, table oder widetable im Terminal, json in einer Pipe

status200 <resource> get

Liest einen Datensatz. Nur Datensätze: Telemetrie hat kein get.

Bash 
status200 <resource> get <id> [-o <format>]
Argument oder OptionErforderlichWas es ist
<id>JaDie ID des Datensatzes, eine UUID
-o, --output <format>Neinjson, table oder wide

status200 <resource> create

Erstellt einen Datensatz und gibt ihn aus.

Bash 
status200 <resource> create (--data <json> | --file <path>) [-o <format>]
OptionErforderlichWas es ist
--data <json>Eine der beidenDer Datensatz, als JSON
--file <path>Eine der beidenEine JSON-Datei mit dem Datensatz. Zusammen mit --data angegeben, wird die Datei verwendet
-o, --output <format>Neinjson, table oder wide

status200 <resource> update

Ändert die Felder, die Sie angeben. Nur Datensätze: Telemetrie hat kein update.

Bash 
status200 <resource> update <id> --data <json> [-o <format>]
Argument oder OptionErforderlichWas es ist
<id>JaDie ID des Datensatzes
--data <json>JaDie zu ändernden Felder, als JSON
-o, --output <format>Neinjson, table oder wide

status200 <resource> delete

Löscht einen Datensatz sofort, ohne zu fragen. Nur Datensätze: Telemetrie hat kein delete.

Bash 
status200 <resource> delete <id> [--force]
Argument oder OptionErforderlichWas es ist
<id>JaDie ID des Datensatzes
--forceNeinWird angenommen und ändert nichts: delete fragt nie nach einer Bestätigung

status200 <resource> count

Zählt Datensätze und gibt die Zahl aus.

Bash 
status200 <resource> count [--query <json>] [-o <format>]
OptionErforderlichWas es ist
--query <json>NeinEin Filter, als JSON. Ohne ihn jeder Datensatz, den der Schlüssel lesen darf
-o, --output <format>Neinjson, table oder wide

Ressourcen

Datensätze nehmen list, get, create, update, delete und count:

BereichBefehle
Überwachungmonitor, monitor-status, monitor-status-event
Vorfälleincident, incident-state, incident-severity, incident-state-timeline, incident-public-note, incident-internal-note, incident-alert, postmortem-status
Warnungenalert, alert-state, alert-severity, alert-state-timeline, alert-internal-note
Statusseitenstatus-page, status-page-announcement
Geplante Wartungscheduled-maintenance-event, scheduled-maintenance-state, scheduled-maintenance-state-timeline
Teams und Bereitschaftteam, on-call-policy
Sicherheitsecurity-case, security-case-note, security-detection, security-playbook
Labelslabel

Telemetrie nimmt list, create und count:

BereichBefehle
Beobachtbarkeitlog, metric, span, exception-instance, monitor-log
Sicherheitsecurity-event, threat-intel-indicator
Änderungen und Kostenchange-event, kubernetes-cost-allocation

Die CLI erscheint mit Status200, daher listet status200 resources die Befehle der Version auf, die Sie installiert haben.

API-Anfragen

Jede Operation ist eine Anfrage an die API, mit dem Schlüssel im Header APIKey. <path> ist der API-Pfad der Ressource, aus status200 resources: /incident für incident, /on-call-duty-policy für on-call-policy.

OperationAnfrageBody
listPOST /api/<path>/get-listquery, select, skip, limit und sort
getPOST /api/<path>/<id>/get-itemselect
createPOST /api/<path>{"data": ...}
updatePUT /api/<path>/<id>/{"data": ...}
deleteDELETE /api/<path>/<id>/Keiner
countPOST /api/<path>/countquery

Weitere Befehle

status200 deploy

Zeichnet einen Deploy oder eine andere Änderung aus einer Pipeline auf: Sie wird in die Diagramme des Dienstes eingezeichnet und von Status200 AI gelesen, wenn es einen Vorfall untersucht. Der Befehl schreibt mit einem Telemetrie-Ingestion-Schlüssel, nicht mit einem API-Schlüssel. Siehe Deploys und Änderungen.

Bash 
status200 deploy [--service <name>] [--service-version <version>] [--previous-version <version>] [--commit <sha>] [--repository <url>] [--branch <name>] [--pull-request <number>] [--environment <name>] [--title <title>] [--description <text>] [--type <type>] [--time <time>] [--attribute <key=value...>] [--ingestion-key <key>]
OptionErforderlichWas es istStandard
--service <name>NeinDer Dienst, der deployt wurdeEine Änderung für das ganze Projekt
--service-version <version>NeinDie deployte Version
--previous-version <version>NeinDie Version, die sie ersetzt hat
--commit <sha>NeinDer deployte Commit
--repository <url>NeinDas Repository, in dem der Commit liegt
--branch <name>NeinDer deployte Branch
--pull-request <number>NeinDer deployte Pull Request
--environment <name>NeinDie Umgebung, in die deployt wurde
--title <title>NeinDer Titel der Änderung; eine andere Art als ein Deploy braucht einenDeploy <version>
--description <text>NeinDetails der Änderung
--type <type>NeinDie Art der Änderung, etwa config-change oder rollbackdeployment
--time <time>NeinWann sie geschah, etwa 2026-10-19T10:00:00ZJetzt
--attribute <key=value...>NeinWeitere Attribute, als key=value, eines oder mehrere
--ingestion-key <key>NeinEin Telemetrie-Ingestion-Schlüssel des ProjektsSTATUS200_TELEMETRY_INGESTION_KEY

status200 whoami

Zeigt die URL und den API-Schlüssel, die der nächste Befehl verwendet, mit maskiertem Schlüssel, und den Kontext, aus dem sie stammen. Es ruft Status200 nicht auf. Siehe Prüfen, was die CLI verwenden wird.

Bash 
status200 whoami

status200 resources

Listet jede Art von Datensatz auf, für die die CLI einen Befehl hat: ihren Befehl, Singular- und Pluralnamen, Typ und API-Pfad sowie die Gesamtzahl.

Bash 
status200 resources [--type <type>] [-o <format>]
OptionErforderlichWas es istStandard
--type <type>Neindatabase für Datensätze, analytics für TelemetrieBeide
-o, --output <format>Neinjson, table oder wide. JSON liefert von jeder name, singularName, pluralName, modelType und apiPathtable im Terminal, json in einer Pipe

status200 version

Gibt die Version der CLI aus, wie status200 --version.

Bash 
status200 version

status200 help

Zeigt die Hilfe der CLI oder eines Befehls.

Bash 
status200 help [command]

Umgebungsvariablen

VariableWas sie tut
STATUS200_API_KEYDer API-Schlüssel, wenn kein Flag --api-key einen angibt
STATUS200_URLDie Adresse Ihrer Status200-Instanz, wenn kein Flag --url eine angibt
STATUS200_TELEMETRY_INGESTION_KEYDer Telemetrie-Ingestion-Schlüssel, mit dem status200 deploy schreibt, wenn kein Flag --ingestion-key einen angibt
NO_COLORAuf einen beliebigen Wert gesetzt, schaltet sie Farben aus

Dateien

DateiWas sie enthält
~/.oneuptime/config.jsonDie gespeicherten Kontexte, ihre API-Schlüssel und den aktuellen Kontext

Exit-Codes

CodeBedeutung
0Es hat geklappt
1Es ist fehlgeschlagen: Status200 hat die Anfrage abgelehnt, oder der Befehl war falsch
2Kein verwendbarer API-Schlüssel: keiner gefunden, ungültig oder unter seinem Tarif
3Nicht gefunden: Status200 hat mit 404 geantwortet

Beispiele finden Sie unter Exit-Codes.

Nächste Schritte

CLI – ÜbersichtDie CLI installieren und die ersten Befehle ausführen.RessourcenoperationenBeispiele für jede Operation.Skripting & CI/CDDie CLI in Skripten und Pipelines.