Gå til indhold
Dokumentation
Kommandoreference

Kommandoreference

Vis som Markdown

Hver kommando i CLI'en status200 med dens argumenter, indstillinger og standardværdier. Føj --help til en hvilken som helst kommando for at se det samme i din terminal.

Globale indstillingerDe indstillinger, hver kommando tager.Login og konteksterlogin og context-kommandoerne.Ressourcekommandoerlist, get, create, update, delete og count.Andre kommandoerdeploy, whoami, resources, version og help.

Kommandoerne

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 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"]

Kommandoerne i CLI'en status200

Globale indstillinger

IndstillingHvad den gørStandard
--api-key <key>API-nøglen til denne kommandoSTATUS200_API_KEY, derefter kontekstens nøgle
--url <url>Adressen på din Status200 til denne kommandoSTATUS200_URL, derefter kontekstens URL
--context <name>Den gemte kontekst, der bruges til denne kommandoDen aktuelle kontekst
-o, --output <format>json, table eller widetable i en terminal, json i en pipe
--no-colorUdskriver uden farverFarver, medmindre NO_COLOR er sat
-V, --versionUdskriver CLI'ens version
-h, --helpViser hjælpen til en kommando

Indstillingerne står før eller efter kommandoen: status200 --context staging incident list og status200 incident list --context staging gør det samme.

Login og kontekster

status200 login

Gemmer en API-nøgle og en adresse som en kontekst og gør den til den aktuelle. Se Log ind.

Bash 
status200 login <api-key> <instance-url> [--context-name <name>]
Argument eller indstillingPåkrævetHvad det erStandard
<api-key>JaEn API-nøgle til dit projekt
<instance-url>JaAdressen på din Status200, for eksempel https://status200.ru
--context-name <name>NejNavnet, konteksten gemmes underdefault

status200 context list

Viser de gemte kontekster; * markerer den aktuelle. API-nøgler vises aldrig.

Bash 
status200 context list [-o <format>]
IndstillingPåkrævetHvad det er
-o, --output <format>Nejjson, table eller wide. JSON giver hver konteksts name, apiUrl og isCurrent

status200 context use

Gør en gemt kontekst til den aktuelle.

Bash 
status200 context use <name>
ArgumentPåkrævetHvad det er
<name>JaNavnet på en gemt kontekst

status200 context current

Viser den aktuelle konteksts navn og URL og dens API-nøgle, skjult bortset fra de første fire og sidste fire tegn.

Bash 
status200 context current

status200 context delete

Sletter en gemt kontekst. Var det den aktuelle, bliver den første tilbageværende kontekst den aktuelle.

Bash 
status200 context delete <name>
ArgumentPåkrævetHvad det er
<name>JaNavnet på en gemt kontekst

Ressourcekommandoer

<resource> er kommandoen til en slags post fra tabellerne under Ressourcer, for eksempel incident eller monitor. Se Ressourceoperationer for eksempler.

status200 <resource> list

Viser poster, de nyeste først. Etiketter vises i stedet efter navn, nummererede etiketter først (2. Team før 10. Owner).

Bash 
status200 <resource> list [--query <json>] [--limit <n>] [--skip <n>] [--sort <json>] [-o <format>]
IndstillingHvad den gørStandard
--query <json>Et filter som JSONHver post, nøglen må læse
--limit <n>Det største antal poster, der returneres, op til 10.00010
--skip <n>Hvor mange poster der springes over først0
--sort <json>Rækkefø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

Læser én post. Kun poster: telemetri har ingen get.

Bash 
status200 <resource> get <id> [-o <format>]
Argument eller indstillingPåkrævetHvad det er
<id>JaPostens ID, et UUID
-o, --output <format>Nejjson, table eller wide

status200 <resource> create

Opretter en post og udskriver den.

Bash 
status200 <resource> create (--data <json> | --file <path>) [-o <format>]
IndstillingPåkrævetHvad det er
--data <json>Én af de toPosten som JSON
--file <path>Én af de toEn JSON-fil med posten. Angivet sammen med --data bruges filen
-o, --output <format>Nejjson, table eller wide

status200 <resource> update

Ændrer de felter, du angiver. Kun poster: telemetri har ingen update.

Bash 
status200 <resource> update <id> --data <json> [-o <format>]
Argument eller indstillingPåkrævetHvad det er
<id>JaPostens ID
--data <json>JaDe felter, der skal ændres, som JSON
-o, --output <format>Nejjson, table eller wide

status200 <resource> delete

Sletter en post med det samme uden at spørge. Kun poster: telemetri har ingen delete.

Bash 
status200 <resource> delete <id> [--force]
Argument eller indstillingPåkrævetHvad det er
<id>JaPostens ID
--forceNejAccepteres og ændrer intet: delete beder aldrig om bekræftelse

status200 <resource> count

Tæller poster og udskriver tallet.

Bash 
status200 <resource> count [--query <json>] [-o <format>]
IndstillingPåkrævetHvad det er
--query <json>NejEt filter som JSON. Uden et filter hver post, nøglen må læse
-o, --output <format>Nejjson, table eller wide

Ressourcer

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

OmrådeKommandoer
Overvågningmonitor, monitor-status, monitor-status-event
Hændelserincident, incident-state, incident-severity, incident-state-timeline, incident-public-note, incident-internal-note, incident-alert, postmortem-status
Advarsleralert, alert-state, alert-severity, alert-state-timeline, alert-internal-note
Statussiderstatus-page, status-page-announcement
Planlagt vedligeholdelsescheduled-maintenance-event, scheduled-maintenance-state, scheduled-maintenance-state-timeline
Teams og vagtteam, on-call-policy
Sikkerhedsecurity-case, security-case-note, security-detection, security-playbook
Etiketterlabel

Telemetri tager list, create og count:

OmrådeKommandoer
Observerbarhedlog, metric, span, exception-instance, monitor-log
Sikkerhedsecurity-event, threat-intel-indicator
Ændringer og omkostningerchange-event, kubernetes-cost-allocation

CLI'en udgives sammen med Status200, så status200 resources viser kommandoerne i den version, du har installeret.

API-anmodninger

Hver operation er én anmodning til API'et med nøglen i headeren APIKey. <path> er ressourcens API-sti fra status200 resources: /incident for incident, /on-call-duty-policy for on-call-policy.

OperationAnmodningBody
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 udrulning eller en anden ændring fra en pipeline: den tegnes på tjenestens grafer og læses af Status200 AI, når den undersøger en hændelse. Den skriver med en telemetri-indtagelsesnøgle, ikke en API-nøgle. Se Udrulninger og ændringer.

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>]
IndstillingPåkrævetHvad det erStandard
--service <name>NejDen tjeneste, der blev udrulletEn ændring for hele projektet
--service-version <version>NejDen udrullede version
--previous-version <version>NejDen version, den erstattede
--commit <sha>NejDen udrullede commit
--repository <url>NejDet repository, committen ligger i
--branch <name>NejDen udrullede branch
--pull-request <number>NejDen udrullede pull request
--environment <name>NejDet miljø, der blev udrullet til
--title <title>NejÆndringens titel; en anden slags end en udrulning skal have enDeploy <version>
--description <text>NejDetaljer om ændringen
--type <type>NejTypen af ændring, for eksempel config-change eller rollbackdeployment
--time <time>NejHvornår det skete, for eksempel 2026-10-19T10:00:00ZNu
--attribute <key=value...>NejFlere attributter som key=value, én eller flere
--ingestion-key <key>NejEn telemetri-indtagelsesnøgle til projektetSTATUS200_TELEMETRY_INGESTION_KEY

status200 whoami

Viser den URL og API-nøgle, den næste kommando vil bruge, med nøglen maskeret, og den kontekst, de kommer fra. Den kalder ikke Status200. Se Tjek, hvad CLI'en vil bruge.

Bash 
status200 whoami

status200 resources

Viser hver slags post, CLI'en har en kommando til: dens kommando, navne i ental og flertal, type og API-sti samt det samlede antal.

Bash 
status200 resources [--type <type>] [-o <format>]
IndstillingPåkrævetHvad det erStandard
--type <type>Nejdatabase for poster, analytics for telemetriBegge
-o, --output <format>Nejjson, table eller wide. JSON giver hver enkelts name, singularName, pluralName, modelType og apiPathtable i en terminal, json i en pipe

status200 version

Udskriver CLI'ens version, ligesom status200 --version gør.

Bash 
status200 version

status200 help

Viser hjælpen til CLI'en eller til en kommando.

Bash 
status200 help [command]

Miljøvariabler

VariabelHvad den gør
STATUS200_API_KEYAPI-nøglen, når intet --api-key-flag giver en
STATUS200_URLAdressen på din Status200, når intet --url-flag giver en
STATUS200_TELEMETRY_INGESTION_KEYDen telemetri-indtagelsesnøgle, status200 deploy skriver med, når intet --ingestion-key-flag giver en
NO_COLORSat til en vilkårlig værdi slår den farver fra

Filer

FilHvad den indeholder
~/.oneuptime/config.jsonDe gemte kontekster, deres API-nøgler og den aktuelle kontekst

Exitkoder

KodeBetydning
0Det lykkedes
1Det mislykkedes: Status200 afviste anmodningen, eller kommandoen var forkert
2Ingen brugbar API-nøgle: ingen fundet, ugyldig eller under sit abonnement
3Ikke fundet: Status200 svarede 404

Se Exitkoder for eksempler.

Næste skridt

CLI – OversigtInstallér CLI'en, og kør dine første kommandoer.RessourceoperationerEksempler på hver operation.Scripting og CI/CDCLI'en i scripts og pipelines.