Naar inhoud springen
Documentatie
CLI – Overzicht

CLI – Overzicht

Bekijken als Markdown

De Status200-CLI, status200, beheert je Status200-project vanuit een terminal of een script. Hij toont, leest, maakt, wijzigt, verwijdert en telt monitoren, incidenten, waarschuwingen, statuspagina's en de andere records die de Status200-API aanbiedt, met een API-sleutel van je project.

Hoe de CLI werktEén opdracht, één API-verzoek, één antwoord.De CLI installerenEén npm-opdracht, en welke versie je kiest.Je eerste opdrachten uitvoerenSla je API-sleutel op en toon dan je incidenten.De opdrachten in één oogopslagElke opdracht, en de pagina die hem uitlegt.

Hoe de CLI werkt

Elke opdracht stuurt één verzoek naar de REST API van Status200 en drukt het antwoord af. De CLI haalt de API-sleutel en het adres van je Status200 uit vlaggen, omgevingsvariabelen of een context die status200 login heeft opgeslagen. De sleutel bepaalt wat een opdracht mag lezen en wijzigen, precies zoals bij de API.

flowchart TB T["Je terminal<br/>of een CI-job"] -->|"status200 incident list"| C["status200-CLI"] K["De API-sleutel en URL:<br/>vlaggen, omgeving<br/>of een opgeslagen context"] --> C C -->|"POST /api/incident/get-list"| A["REST API van Status200"] A -->|"de records die de<br/>sleutel mag lezen,<br/>als JSON"| C C -->|"een tabel in een terminal,<br/>JSON in een pipe"| T

Eén opdracht, één verzoek

De opdrachten voor records komen met de CLI mee: elk soort record dat de Status200-API voor tools openstelt, heeft er een, dezelfde records waarvoor de MCP-server tools heeft. Voer status200 resources uit om ze te tonen.

Voordat je begint

  • Node.js en npm, een actuele LTS-release, om de CLI te installeren.
  • Een API-sleutel van je project. Maak er een aan in Projectinstellingen → Geavanceerd → API-sleutels met API-sleutel aanmaken: zie Een API-sleutel aanmaken.
  • Op Status200 Cloud het Growth-abonnement of hoger. De API-sleutels van een project werken alleen daarop: zie API-sleutels en SCIM onder hun abonnement.

De CLI installeren

Installeer het pakket @status200/cli vanuit npm. Het voegt de opdracht status200 toe, en --version drukt de geïnstalleerde versie af:

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

De CLI verschijnt samen met Status200 en heeft hetzelfde versienummer. Op een zelf gehoste Status200 installeer je de CLI van de versie van je Status200, zodat de opdrachten passen bij de records die je server heeft:

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

Je eerste opdrachten uitvoeren

  1. Je API-sleutel opslaan

    Log in met de sleutel en het adres van je Status200. De CLI slaat ze op als een context met de naam default en gebruikt die vanaf nu:

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

    Hij antwoordt Logged in successfully. Context "default" is now active. Gebruik op een zelf gehoste Status200 het adres daarvan in plaats van https://status200.ru.

  2. Je incidenten tonen

    Bash 
    status200 incident list

    De tien nieuwste incidenten verschijnen als tabel. login slaat de sleutel op zonder hem te controleren, dus dit is de eerste opdracht die laat zien dat de sleutel werkt: wordt hij geweigerd, zie dan Problemen oplossen.

  3. Zien wat je nog meer kunt beheren

    Bash 
    status200 resources

    De lijst toont elk soort record waarmee je kunt werken, en de opdracht ervan, zoals monitor, status-page of on-call-policy.

De opdrachten in één oogopslag

OpdrachtWat hij doetMeer lezen
status200 login <api-key> <instance-url>Slaat een API-sleutel en een adres op als contextAuthenticatie
status200 context list, use, current, deleteToont, wisselt, laat zien en verwijdert opgeslagen contextenAuthenticatie
status200 whoamiToont de URL en API-sleutel die de volgende opdracht gebruiktAuthenticatie
status200 deployLegt een deploy, of een andere wijziging, vast voor grafieken en Status200 AIDeploys en wijzigingen
status200 <resource> list, get, create, update, delete, countWerkt met één soort recordBewerkingen op bronnen
status200 resourcesToont de soorten records, met hun opdrachtenOpdrachtreferentie
status200 versionDrukt de versie van de CLI afOpdrachtreferentie
status200 help [command]Toont de hulp van een opdrachtHulp krijgen

Globale opties

Deze opties werken met elke opdracht, ervoor of erna:

OptieWat hij doet
--api-key <key>De API-sleutel voor deze opdracht, in plaats van de opgeslagen
--url <url>Het adres van je Status200 voor deze opdracht
--context <name>Een opgeslagen context voor deze opdracht, in plaats van de huidige
-o, --output <format>table, json of wide: zie Uitvoerformaten
--no-colorDrukt af zonder kleuren
-V, --versionDrukt de versie van de CLI af
-h, --helpToont de hulp van de opdracht

Hulp krijgen

Elke opdracht heeft zijn eigen hulp, met zijn argumenten, opties en standaardwaarden:

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

Volgende stappen

AuthenticatieContexten voor elke omgeving, en welke sleutel een opdracht gebruikt.Bewerkingen op bronnenRecords tonen, lezen, maken, wijzigen, verwijderen en tellen.UitvoerformatenTabellen voor mensen, JSON voor scripts.Scripting en CI/CDExitcodes, jq en pipelines.OpdrachtreferentieElke opdracht, optie en standaardwaarde.