Gå til indhold
Dokumentation
CLI – Oversigt

CLI – Oversigt

Vis som Markdown

Status200-CLI'en, status200, administrerer dit Status200-projekt fra en terminal eller et script. Den viser, læser, opretter, ændrer, sletter og tæller monitorer, hændelser, advarsler, statussider og de andre poster, som Status200-API'et tilbyder, med en API-nøgle til dit projekt.

Sådan virker CLI'enÉn kommando, én API-anmodning, ét svar.Installér CLI'enÉn npm-kommando, og hvilken version du skal vælge.Kør dine første kommandoerGem din API-nøgle, og vis så dine hændelser.Kommandoerne på et øjeblikHver kommando, og siden der forklarer den.

Sådan virker CLI'en

Hver kommando sender én anmodning til Status200s REST API og udskriver svaret. CLI'en tager API-nøglen og adressen på din Status200 fra flag, miljøvariabler eller en kontekst, som status200 login har gemt. Nøglen afgør, hvad en kommando må læse og ændre, præcis som for API'et.

flowchart TB T["Din terminal<br/>eller et CI-job"] -->|"status200 incident list"| C["status200-CLI"] K["API-nøglen og URL'en:<br/>flag, miljø<br/>eller en gemt kontekst"] --> C C -->|"POST /api/incident/get-list"| A["Status200s REST API"] A -->|"de poster, nøglen<br/>må læse, som JSON"| C C -->|"en tabel i en terminal,<br/>JSON i en pipe"| T

Én kommando, én anmodning

Kommandoerne til poster følger med CLI'en: hver slags post, som Status200-API'et åbner for værktøjer, har én, de samme poster, som MCP-serveren har værktøjer til. Kør status200 resources for at vise dem.

Før du begynder

  • Node.js og npm, i en aktuel LTS-version, til at installere CLI'en.
  • En API-nøgle til dit projekt. Opret en under Projektindstillinger → Avanceret → API-nøgler med Opret API-nøgle: se Opret en API-nøgle.
  • På Status200 Cloud abonnementet Growth eller højere. Et projekts API-nøgler virker kun på det: se API-nøgler og SCIM under deres abonnement.

Installér CLI'en

Installér pakken @status200/cli fra npm. Den tilføjer kommandoen status200, og --version udskriver den version, du har installeret:

Bash 
npm install -g @status200/cli
status200 --version

CLI'en udgives sammen med Status200 og har det samme versionsnummer. På en selvhostet Status200 skal du installere CLI'en i din Status200s version, så dens kommandoer passer til de poster, din server har:

Bash 
npm install -g @status200/cli@<your-oneuptime-version>

Kør dine første kommandoer

  1. Gem din API-nøgle

    Log ind med nøglen og adressen på din Status200. CLI'en gemmer dem som en kontekst ved navn default og bruger den fremover:

    Bash 
    status200 login <your-api-key> https://status200.ru

    Den svarer Logged in successfully. Context "default" is now active. På en selvhostet Status200 bruger du dens adresse i stedet for https://status200.ru.

  2. Vis dine hændelser

    Bash 
    status200 incident list

    De ti nyeste hændelser vises som en tabel. login gemmer nøglen uden at tjekke den, så dette er den første kommando, der viser, at nøglen virker: bliver den afvist, så se Fejlfinding.

  3. Se, hvad du ellers kan administrere

    Bash 
    status200 resources

    Listen viser hver slags post, du kan arbejde med, og dens kommando, for eksempel monitor, status-page eller on-call-policy.

Kommandoerne på et øjeblik

KommandoHvad den gørLæs mere
status200 login <api-key> <instance-url>Gemmer en API-nøgle og en adresse som en kontekstGodkendelse
status200 context list, use, current, deleteViser, skifter, oplyser og sletter gemte konteksterGodkendelse
status200 whoamiViser den URL og API-nøgle, som den næste kommando vil brugeGodkendelse
status200 deployRegistrerer en udrulning eller en anden ændring til grafer og Status200 AIUdrulninger og ændringer
status200 <resource> list, get, create, update, delete, countArbejder med én slags postRessourceoperationer
status200 resourcesViser slagsene af poster med deres kommandoerKommandoreference
status200 versionUdskriver CLI'ens versionKommandoreference
status200 help [command]Viser hjælpen til en kommandoFå hjælp

Globale indstillinger

Disse indstillinger virker med alle kommandoer, før eller efter dem:

IndstillingHvad den gør
--api-key <key>API-nøglen til denne kommando, i stedet for den gemte
--url <url>Adressen på din Status200 til denne kommando
--context <name>En gemt kontekst til denne kommando, i stedet for den aktuelle
-o, --output <format>table, json eller wide: se Outputformater
--no-colorUdskriver uden farver
-V, --versionUdskriver CLI'ens version
-h, --helpViser hjælpen til kommandoen

Få hjælp

Hver kommando har sin egen hjælp med sine argumenter, indstillinger og standardværdier:

Bash 
status200 --help
status200 help incident
status200 incident list --help

Næste skridt

GodkendelseKontekster for hvert miljø, og hvilken nøgle en kommando bruger.RessourceoperationerVis, læs, opret, ændr, slet og tæl poster.OutputformaterTabeller til mennesker, JSON til scripts.Scripting og CI/CDExitkoder, jq og pipelines.KommandoreferenceHver kommando, indstilling og standardværdi.