Gå til innhold
Dokumentasjon
Kommandoreferanse

Kommandoreferanse

Vis som Markdown

Hver kommando i CLI-en status200, med argumentene, alternativene og standardverdiene sine. Legg --help til en hvilken som helst kommando for å se det samme i terminalen din.

Globale alternativerAlternativene hver kommando tar.Innlogging og konteksterlogin og context-kommandoene.Ressurskommandoerlist, get, create, update, delete og count.Andre kommandoerdeploy, whoami, resources, version og help.

Kommandoene

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

Kommandoene i CLI-en status200

Globale alternativer

AlternativHva det gjørStandard
--api-key <key>API-nøkkelen for denne kommandoenSTATUS200_API_KEY, så kontekstens nøkkel
--url <url>Adressen til Status200-en din for denne kommandoenSTATUS200_URL, så kontekstens URL
--context <name>Den lagrede konteksten som brukes for denne kommandoenDen gjeldende konteksten
-o, --output <format>json, table eller widetable i en terminal, json i en pipe
--no-colorSkriver ut uten fargerFarger, med mindre NO_COLOR er satt
-V, --versionSkriver ut CLI-ens versjon
-h, --helpViser hjelpen til en kommando

Alternativene står før eller etter kommandoen: status200 --context staging incident list og status200 incident list --context staging gjør det samme.

Innlogging og kontekster

status200 login

Lagrer en API-nøkkel og en adresse som en kontekst, og gjør den til den gjeldende. Se Logg inn.

Bash 
status200 login <api-key> <instance-url> [--context-name <name>]
Argument eller alternativPåkrevdHva det erStandard
<api-key>JaEn API-nøkkel til prosjektet ditt
<instance-url>JaAdressen til Status200-en din, for eksempel https://status200.ru
--context-name <name>NeiNavnet konteksten lagres underdefault

status200 context list

Lister de lagrede kontekstene; * markerer den gjeldende. API-nøkler listes aldri.

Bash 
status200 context list [-o <format>]
AlternativPåkrevdHva det er
-o, --output <format>Neijson, table eller wide. JSON gir hver konteksts name, apiUrl og isCurrent

status200 context use

Gjør en lagret kontekst til den gjeldende.

Bash 
status200 context use <name>
ArgumentPåkrevdHva det er
<name>JaNavnet på en lagret kontekst

status200 context current

Viser navnet og URL-en til den gjeldende konteksten, og API-nøkkelen dens skjult bortsett fra de fire første og fire siste tegnene.

Bash 
status200 context current

status200 context delete

Sletter en lagret kontekst. Var det den gjeldende, blir den første gjenværende konteksten gjeldende.

Bash 
status200 context delete <name>
ArgumentPåkrevdHva det er
<name>JaNavnet på en lagret kontekst

Ressurskommandoer

<resource> er kommandoen for en type post, fra tabellene under Ressurser, for eksempel incident eller monitor. Se Ressursoperasjoner for eksempler.

status200 <resource> list

Lister poster, de nyeste først. Etiketter listes i stedet etter navn, nummererte etiketter først (2. Team før 10. Owner).

Bash 
status200 <resource> list [--query <json>] [--limit <n>] [--skip <n>] [--sort <json>] [-o <format>]
AlternativHva det gjørStandard
--query <json>Et filter, som JSONHver post nøkkelen kan lese
--limit <n>Det høyeste antallet poster som returneres, opptil 10 00010
--skip <n>Hvor mange poster som hoppes over først0
--sort <json>Rekkefølgen, som JSON: {"<field>":"ASC"} eller {"<field>":"DESC"}De nyeste først
-o, --output <format>json, table eller widetable i en terminal, json i en pipe

status200 <resource> get

Leser én post. Bare poster: telemetri har ingen get.

Bash 
status200 <resource> get <id> [-o <format>]
Argument eller alternativPåkrevdHva det er
<id>JaPostens ID, en UUID
-o, --output <format>Neijson, table eller wide

status200 <resource> create

Oppretter en post og skriver den ut.

Bash 
status200 <resource> create (--data <json> | --file <path>) [-o <format>]
AlternativPåkrevdHva det er
--data <json>Én av de toPosten, som JSON
--file <path>Én av de toEn JSON-fil med posten. Oppgitt sammen med --data brukes filen
-o, --output <format>Neijson, table eller wide

status200 <resource> update

Endrer feltene du oppgir. Bare poster: telemetri har ingen update.

Bash 
status200 <resource> update <id> --data <json> [-o <format>]
Argument eller alternativPåkrevdHva det er
<id>JaPostens ID
--data <json>JaFeltene som skal endres, som JSON
-o, --output <format>Neijson, table eller wide

status200 <resource> delete

Sletter en post med en gang, uten å spørre. Bare poster: telemetri har ingen delete.

Bash 
status200 <resource> delete <id> [--force]
Argument eller alternativPåkrevdHva det er
<id>JaPostens ID
--forceNeiGodtas og endrer ingenting: delete ber aldri om bekreftelse

status200 <resource> count

Teller poster og skriver ut tallet.

Bash 
status200 <resource> count [--query <json>] [-o <format>]
AlternativPåkrevdHva det er
--query <json>NeiEt filter, som JSON. Uten filter hver post nøkkelen kan lese
-o, --output <format>Neijson, table eller wide

Ressurser

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

OmrådeKommandoer
Overvåkingmonitor, monitor-status, monitor-status-event
Hendelserincident, incident-state, incident-severity, incident-state-timeline, incident-public-note, incident-internal-note, incident-alert, postmortem-status
Varsleralert, alert-state, alert-severity, alert-state-timeline, alert-internal-note
Statussiderstatus-page, status-page-announcement
Planlagt vedlikeholdscheduled-maintenance-event, scheduled-maintenance-state, scheduled-maintenance-state-timeline
Team og vaktteam, on-call-policy
Sikkerhetsecurity-case, security-case-note, security-detection, security-playbook
Etiketterlabel

Telemetri tar list, create og count:

OmrådeKommandoer
Observerbarhetlog, metric, span, exception-instance, monitor-log
Sikkerhetsecurity-event, threat-intel-indicator
Endringer og kostnaderchange-event, kubernetes-cost-allocation

CLI-en utgis sammen med Status200, så status200 resources lister kommandoene i versjonen du har installert.

API-forespørsler

Hver operasjon er én forespørsel til API-et, med nøkkelen i headeren APIKey. <path> er ressursens API-sti, fra status200 resources: /incident for incident, /on-call-duty-policy for on-call-policy.

OperasjonForespørselBody
listPOST /api/<path>/get-listquery, select, skip, limit og 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

Andre kommandoer

status200 deploy

Registrerer en utrulling, eller en annen endring, fra en pipeline: den tegnes på tjenestens diagrammer og leses av Status200 AI når den undersøker en hendelse. Den skriver med en telemetri-inntaksnøkkel, ikke en API-nøkkel. Se Utrullinger og endringer.

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>]
AlternativPåkrevdHva det erStandard
--service <name>NeiTjenesten som ble rullet utEn endring for hele prosjektet
--service-version <version>NeiVersjonen som ble rullet ut
--previous-version <version>NeiVersjonen den erstattet
--commit <sha>NeiCommiten som ble rullet ut
--repository <url>NeiRepositoriet commiten ligger i
--branch <name>NeiBranchen som ble rullet ut
--pull-request <number>NeiPull requesten som ble rullet ut
--environment <name>NeiMiljøet det ble rullet ut til
--title <title>NeiEndringens tittel; en annen type enn en utrulling trenger enDeploy <version>
--description <text>NeiDetaljer om endringen
--type <type>NeiTypen endring, for eksempel config-change eller rollbackdeployment
--time <time>NeiNår det skjedde, for eksempel 2026-10-19T10:00:00ZNå
--attribute <key=value...>NeiFlere attributter, som key=value, ett eller flere
--ingestion-key <key>NeiEn telemetri-inntaksnøkkel til prosjektetSTATUS200_TELEMETRY_INGESTION_KEY

status200 whoami

Viser URL-en og API-nøkkelen som neste kommando vil bruke, med nøkkelen maskert, og konteksten de kommer fra. Den kaller ikke Status200. Se Sjekk hva CLI-en vil bruke.

Bash 
status200 whoami

status200 resources

Lister hver type post CLI-en har en kommando for: kommandoen, navnene i entall og flertall, typen og API-stien, og totalen.

Bash 
status200 resources [--type <type>] [-o <format>]
AlternativPåkrevdHva det erStandard
--type <type>Neidatabase for poster, analytics for telemetriBegge
-o, --output <format>Neijson, table eller wide. JSON gir hver enkelts name, singularName, pluralName, modelType og apiPathtable i en terminal, json i en pipe

status200 version

Skriver ut CLI-ens versjon, slik status200 --version gjør.

Bash 
status200 version

status200 help

Viser hjelpen til CLI-en, eller til en kommando.

Bash 
status200 help [command]

Miljøvariabler

VariabelHva den gjør
STATUS200_API_KEYAPI-nøkkelen, når ingen --api-key-flagg gir en
STATUS200_URLAdressen til Status200-en din, når ingen --url-flagg gir en
STATUS200_TELEMETRY_INGESTION_KEYTelemetri-inntaksnøkkelen status200 deploy skriver med, når ingen --ingestion-key-flagg gir en
NO_COLORSatt til en hvilken som helst verdi slår den av farger

Filer

FilHva den inneholder
~/.oneuptime/config.jsonDe lagrede kontekstene, API-nøklene deres og den gjeldende konteksten

Avslutningskoder

KodeBetydning
0Det virket
1Det mislyktes: Status200 avviste forespørselen, eller kommandoen var feil
2Ingen brukbar API-nøkkel: ingen funnet, ugyldig eller under abonnementet sitt
3Ikke funnet: Status200 svarte 404

Se Avslutningskoder for eksempler.

Neste steg

CLI – OversiktInstaller CLI-en og kjør de første kommandoene.RessursoperasjonerEksempler på hver operasjon.Skripting og CI/CDCLI-en i skript og pipelines.