Hoppa till innehåll
Dokumentation
Kommandoreferens

Kommandoreferens

Visa som Markdown

Varje kommando i CLI:n status200, med dess argument, alternativ och standardvärden. Lägg till --help till vilket kommando som helst för att se samma sak i din terminal.

Globala alternativAlternativen som varje kommando tar.Inloggning och kontexterlogin och context-kommandona.Resurskommandonlist, get, create, update, delete och count.Andra kommandondeploy, whoami, resources, version och help.

Kommandona

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

Kommandona i CLI:n status200

Globala alternativ

AlternativVad det görStandard
--api-key <key>API-nyckeln för det här kommandotSTATUS200_API_KEY, sedan kontextens nyckel
--url <url>Adressen till ditt Status200 för det här kommandotSTATUS200_URL, sedan kontextens URL
--context <name>Den sparade kontexten som används för det här kommandotDen aktuella kontexten
-o, --output <format>json, table eller widetable i en terminal, json i en pipe
--no-colorSkriver ut utan färgerFärger, om inte NO_COLOR är satt
-V, --versionSkriver ut CLI:ns version
-h, --helpVisar hjälpen för ett kommando

Alternativen står före eller efter kommandot: status200 --context staging incident list och status200 incident list --context staging gör samma sak.

Inloggning och kontexter

status200 login

Sparar en API-nyckel och en adress som en kontext, och gör den till den aktuella. Se Logga in.

Bash 
status200 login <api-key> <instance-url> [--context-name <name>]
Argument eller alternativKrävsVad det ärStandard
<api-key>JaEn API-nyckel till ditt projekt
<instance-url>JaAdressen till ditt Status200, till exempel https://status200.ru
--context-name <name>NejNamnet som kontexten sparas underdefault

status200 context list

Listar de sparade kontexterna; * markerar den aktuella. API-nycklar listas aldrig.

Bash 
status200 context list [-o <format>]
AlternativKrävsVad det är
-o, --output <format>Nejjson, table eller wide. JSON ger varje kontexts name, apiUrl och isCurrent

status200 context use

Gör en sparad kontext till den aktuella.

Bash 
status200 context use <name>
ArgumentKrävsVad det är
<name>JaNamnet på en sparad kontext

status200 context current

Visar den aktuella kontextens namn och URL, och dess API-nyckel dold utom de fyra första och fyra sista tecknen.

Bash 
status200 context current

status200 context delete

Tar bort en sparad kontext. Var det den aktuella, blir den första kvarvarande kontexten aktuell.

Bash 
status200 context delete <name>
ArgumentKrävsVad det är
<name>JaNamnet på en sparad kontext

Resurskommandon

<resource> är kommandot för en sorts post, från tabellerna under Resurser, till exempel incident eller monitor. Se Resursoperationer för exempel.

status200 <resource> list

Listar poster, de nyaste först. Etiketter listas i stället efter namn, numrerade etiketter först (2. Team före 10. Owner).

Bash 
status200 <resource> list [--query <json>] [--limit <n>] [--skip <n>] [--sort <json>] [-o <format>]
AlternativVad det görStandard
--query <json>Ett filter, som JSONVarje post som nyckeln får läsa
--limit <n>Det högsta antalet poster att returnera, upp till 10 00010
--skip <n>Hur många poster som hoppas över först0
--sort <json>Ordningen, som JSON: {"<field>":"ASC"} eller {"<field>":"DESC"}De nyaste först
-o, --output <format>json, table eller widetable i en terminal, json i en pipe

status200 <resource> get

Läser en post. Bara poster: telemetri har ingen get.

Bash 
status200 <resource> get <id> [-o <format>]
Argument eller alternativKrävsVad det är
<id>JaPostens ID, ett UUID
-o, --output <format>Nejjson, table eller wide

status200 <resource> create

Skapar en post och skriver ut den.

Bash 
status200 <resource> create (--data <json> | --file <path>) [-o <format>]
AlternativKrävsVad det är
--data <json>Ett av de tvåPosten, som JSON
--file <path>Ett av de tvåEn JSON-fil med posten. Anges den tillsammans med --data används filen
-o, --output <format>Nejjson, table eller wide

status200 <resource> update

Ändrar de fält du anger. Bara poster: telemetri har ingen update.

Bash 
status200 <resource> update <id> --data <json> [-o <format>]
Argument eller alternativKrävsVad det är
<id>JaPostens ID
--data <json>JaFälten som ska ändras, som JSON
-o, --output <format>Nejjson, table eller wide

status200 <resource> delete

Tar bort en post direkt, utan att fråga. Bara poster: telemetri har ingen delete.

Bash 
status200 <resource> delete <id> [--force]
Argument eller alternativKrävsVad det är
<id>JaPostens ID
--forceNejGodtas och ändrar ingenting: delete ber aldrig om bekräftelse

status200 <resource> count

Räknar poster och skriver ut talet.

Bash 
status200 <resource> count [--query <json>] [-o <format>]
AlternativKrävsVad det är
--query <json>NejEtt filter, som JSON. Utan filter varje post som nyckeln får läsa
-o, --output <format>Nejjson, table eller wide

Resurser

Poster tar list, get, create, update, delete och count:

OmrådeKommandon
Övervakningmonitor, monitor-status, monitor-status-event
Incidenterincident, incident-state, incident-severity, incident-state-timeline, incident-public-note, incident-internal-note, incident-alert, postmortem-status
Varningaralert, alert-state, alert-severity, alert-state-timeline, alert-internal-note
Statussidorstatus-page, status-page-announcement
Planerat underhållscheduled-maintenance-event, scheduled-maintenance-state, scheduled-maintenance-state-timeline
Team och jourteam, on-call-policy
Säkerhetsecurity-case, security-case-note, security-detection, security-playbook
Etiketterlabel

Telemetri tar list, create och count:

OmrådeKommandon
Observerbarhetlog, metric, span, exception-instance, monitor-log
Säkerhetsecurity-event, threat-intel-indicator
Ändringar och kostnaderchange-event, kubernetes-cost-allocation

CLI:n släpps tillsammans med Status200, så status200 resources listar kommandona i den version du har installerat.

API-begäranden

Varje operation är en begäran till API:et, med nyckeln i headern APIKey. <path> är resursens API-sökväg, från status200 resources: /incident för incident, /on-call-duty-policy för on-call-policy.

OperationBegäranBody
listPOST /api/<path>/get-listquery, select, skip, limit och sort
getPOST /api/<path>/<id>/get-itemselect
createPOST /api/<path>{"data": ...}
updatePUT /api/<path>/<id>/{"data": ...}
deleteDELETE /api/<path>/<id>/Ingen
countPOST /api/<path>/countquery

Andra kommandon

status200 deploy

Registrerar en driftsättning, eller en annan ändring, från en pipeline: den ritas i tjänstens diagram och läses av Status200 AI när den utreder en incident. Kommandot skriver med en intagningsnyckel för telemetri, inte med en API-nyckel. Se Driftsättningar och ändringar.

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>]
AlternativKrävsVad det ärStandard
--service <name>NejTjänsten som driftsattesEn ändring för hela projektet
--service-version <version>NejDen driftsatta versionen
--previous-version <version>NejVersionen som den ersatte
--commit <sha>NejDen driftsatta committen
--repository <url>NejRepositoryt som committen finns i
--branch <name>NejDen driftsatta branchen
--pull-request <number>NejDen driftsatta pull requesten
--environment <name>NejMiljön som driftsättningen gjordes i
--title <title>NejÄndringens titel; krävs för alla sorters ändringar utom driftsättningarDeploy <version>
--description <text>NejDetaljer om ändringen
--type <type>NejTypen av ändring, till exempel config-change eller rollbackdeployment
--time <time>NejNär den hände, till exempel 2026-10-19T10:00:00ZNu
--attribute <key=value...>NejFler attribut, som key=value, ett eller flera
--ingestion-key <key>NejEn intagningsnyckel för telemetri från projektetSTATUS200_TELEMETRY_INGESTION_KEY

status200 whoami

Visar URL:en och API-nyckeln som nästa kommando kommer att använda, med nyckeln maskerad, och kontexten de kommer från. Den anropar inte Status200. Se Kontrollera vad CLI:n kommer att använda.

Bash 
status200 whoami

status200 resources

Listar varje sorts post som CLI:n har ett kommando för: dess kommando, namn i singular och plural, typ och API-sökväg, samt totalen.

Bash 
status200 resources [--type <type>] [-o <format>]
AlternativKrävsVad det ärStandard
--type <type>Nejdatabase för poster, analytics för telemetriBåda
-o, --output <format>Nejjson, table eller wide. JSON ger var och ens name, singularName, pluralName, modelType och apiPathtable i en terminal, json i en pipe

status200 version

Skriver ut CLI:ns version, som status200 --version gör.

Bash 
status200 version

status200 help

Visar hjälpen för CLI:n, eller för ett kommando.

Bash 
status200 help [command]

Miljövariabler

VariabelVad den gör
STATUS200_API_KEYAPI-nyckeln, när ingen --api-key-flagga anger en
STATUS200_URLAdressen till ditt Status200, när ingen --url-flagga anger en
STATUS200_TELEMETRY_INGESTION_KEYIntagningsnyckeln för telemetri som status200 deploy skriver med, när ingen --ingestion-key-flagga anger en
NO_COLORSatt till valfritt värde stänger den av färger

Filer

FilVad den innehåller
~/.oneuptime/config.jsonDe sparade kontexterna, deras API-nycklar och den aktuella kontexten

Slutkoder

KodBetydelse
0Det fungerade
1Det misslyckades: Status200 avvisade begäran, eller kommandot var fel
2Ingen användbar API-nyckel: ingen hittad, ogiltig eller under sin plan
3Hittades inte: Status200 svarade 404

Se Slutkoder för exempel.

Nästa steg

CLI – ÖversiktInstallera CLI:n och kör dina första kommandon.ResursoperationerExempel på varje operation.Skript och CI/CDCLI:n i skript och pipelines.