Vai al contenuto
Documentazione
Panoramica della CLI

Panoramica della CLI

Visualizza come Markdown

La CLI di Status200, status200, gestisce il tuo progetto Status200 da un terminale o da uno script. Elenca, legge, crea, modifica, elimina e conta monitor, incidenti, avvisi, pagine di stato e gli altri record che l'API di Status200 offre, con una chiave API del tuo progetto.

Come funziona la CLIUn comando, una richiesta all'API, una risposta.Installare la CLIUn comando npm, e la versione da scegliere.Eseguire i primi comandiSalva la tua chiave API, poi elenca i tuoi incidenti.I comandi in sintesiOgni comando, e la pagina che lo spiega.

Come funziona la CLI

Ogni comando invia una richiesta all'API REST di Status200 e stampa la risposta. La CLI prende la chiave API e l'indirizzo del tuo Status200 da flag, variabili d'ambiente o da un contesto salvato da status200 login. La chiave decide che cosa un comando può leggere e modificare, esattamente come per l'API.

flowchart TB T["Il tuo terminale<br/>o un job di CI"] -->|"status200 incident list"| C["CLI status200"] K["La chiave API e l'URL:<br/>flag, ambiente<br/>o un contesto salvato"] --> C C -->|"POST /api/incident/get-list"| A["API REST di Status200"] A -->|"i record che la chiave<br/>può leggere, in JSON"| C C -->|"una tabella nel terminale,<br/>JSON in una pipe"| T

Un comando, una richiesta

I comandi per i record arrivano con la CLI: ogni tipo di record che l'API di Status200 apre agli strumenti ne ha uno, gli stessi record per cui il server MCP ha degli strumenti. Esegui status200 resources per elencarli.

Prima di iniziare

  • Node.js e npm, in una versione LTS attuale, per installare la CLI.
  • Una chiave API del tuo progetto. Creane una in Impostazioni del progetto → Avanzato → Chiavi API con Crea: Chiave API: vedi Creare una chiave API.
  • Su Status200 Cloud, il piano Growth o superiore. Le chiavi API di un progetto funzionano solo con esso: vedi Chiavi API e SCIM sotto il loro piano.

Installare la CLI

Installa il pacchetto @status200/cli da npm. Aggiunge il comando status200, e --version stampa la versione installata:

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

La CLI esce insieme a Status200 e ha lo stesso numero di versione. Su un Status200 self-hosted, installa la CLI della versione del tuo Status200, così che i suoi comandi corrispondano ai record del tuo server:

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

Eseguire i primi comandi

  1. Salvare la tua chiave API

    Accedi con la chiave e l'indirizzo del tuo Status200. La CLI li salva come un contesto chiamato default e da ora in poi lo usa:

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

    Risponde Logged in successfully. Context "default" is now active. Su un Status200 self-hosted, usa il suo indirizzo al posto di https://status200.ru.

  2. Elencare i tuoi incidenti

    Bash 
    status200 incident list

    I dieci incidenti più recenti compaiono come tabella. login salva la chiave senza verificarla, quindi questo è il primo comando che mostra che la chiave funziona: se viene rifiutata, vedi Risoluzione dei problemi.

  3. Vedere che cos'altro puoi gestire

    Bash 
    status200 resources

    L'elenco mostra ogni tipo di record con cui puoi lavorare, e il suo comando, come monitor, status-page o on-call-policy.

I comandi in sintesi

ComandoChe cosa faPer saperne di più
status200 login <api-key> <instance-url>Salva una chiave API e un indirizzo come contestoAutenticazione
status200 context list, use, current, deleteElenca, cambia, mostra ed elimina i contesti salvatiAutenticazione
status200 whoamiMostra l'URL e la chiave API che userà il prossimo comandoAutenticazione
status200 deployRegistra un deploy, o un'altra modifica, per i grafici e Status200 AIDeploy e modifiche
status200 <resource> list, get, create, update, delete, countLavora con un tipo di recordOperazioni sulle risorse
status200 resourcesElenca i tipi di record, con i loro comandiRiferimento dei comandi
status200 versionStampa la versione della CLIRiferimento dei comandi
status200 help [command]Mostra la guida di un comandoOttenere aiuto

Opzioni globali

Queste opzioni funzionano con ogni comando, prima o dopo di esso:

OpzioneChe cosa fa
--api-key <key>La chiave API per questo comando, al posto di quella salvata
--url <url>L'indirizzo del tuo Status200 per questo comando
--context <name>Un contesto salvato per questo comando, al posto di quello attuale
-o, --output <format>table, json o wide: vedi Formati di output
--no-colorStampa senza colori
-V, --versionStampa la versione della CLI
-h, --helpMostra la guida del comando

Ottenere aiuto

Ogni comando ha la sua guida, con i suoi argomenti, le sue opzioni e i suoi valori predefiniti:

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

Passi successivi

AutenticazioneContesti per ogni ambiente, e quale chiave usa un comando.Operazioni sulle risorseElencare, leggere, creare, modificare, eliminare e contare record.Formati di outputTabelle per le persone, JSON per gli script.Scripting e CI/CDCodici di uscita, jq e pipeline.Riferimento dei comandiOgni comando, opzione e valore predefinito.