Autentisering

Hver forespørsel CLI-en sender, bærer en API-nøkkel til prosjektet ditt. Lagre nøkler én gang med status200 login, én kontekst for hvert miljø, eller gi dem til en kommando i flagg eller miljøvariabler, slik skript gjør. Denne siden viser hver måte, og hvilken en kommando bruker når det er flere.

Før du begynner#

Du trenger en API-nøkkel til prosjektet ditt. Opprett en under Prosjektinnstillinger → Avansert → API-nøkler med Opprett API-nøkkel, og gi den tilgangen kommandoene dine trenger: se Opprett en API-nøkkel. En nøkkel gjør det tillatelsene dens tillater: en nøkkel som bare kan lese poster, kan liste og lese dem, men ikke endre dem.

På Status200 Cloud virker API-nøkler bare mens prosjektet har abonnementet Growth eller høyere. Under det svarer hver kommando med API error (402) og en melding som nevner abonnementet, til prosjektet oppgraderes; da virker den samme nøkkelen igjen. Se API-nøkler og SCIM under abonnementet sitt.

Logg inn#

status200 login lagrer en API-nøkkel og adressen til Status200-en din som en kontekst, og gjør den til den gjeldende konteksten:

status200 login <api-key> <instance-url> [--context-name <name>]

For eksempel en kontekst med navnet production:

status200 login <api-key> https://status200.ru --context-name production

Den svarer Logged in successfully. Context "production" is now active. En skråstrek på slutten av adressen fjernes, og en ny innlogging under samme navn erstatter den konteksten.

Kontekster#

En kontekst er en lagret innlogging: et navn, en adresse og en API-nøkkel. Lagre én for hvert prosjekt eller miljø, og velg så én for alle kommandoene som følger, eller for én enkelt kommando.

1. Lagre en kontekst for hvert miljø#

   Bash

   status200 login <production-api-key> https://status200.ru --context-name production
   status200 login <staging-api-key> https://status200.example.com --context-name staging

   Hver innlogging gjør konteksten sin til den gjeldende, så nå er staging den gjeldende.

2. List dem#

   Bash

   status200 context list

   ┌───┬────────────┬───────────────────────────────┐
   │   │ Name       │ URL                           │
   ├───┼────────────┼───────────────────────────────┤
   │   │ production │ https://status200.ru          │
   ├───┼────────────┼───────────────────────────────┤
   │ * │ staging    │ https://status200.example.com │
   └───┴────────────┴───────────────────────────────┘

   * markerer den gjeldende konteksten. API-nøkler listes aldri.

3. Bytt til en annen kontekst#

   Bash

   status200 context use production

   Den svarer Switched to context "production". og kommandoene som følger, bruker den.

4. Bruk en kontekst for én kommando#

   Bash

   status200 incident list --context staging

   Den gjeldende konteksten forblir som den var.

Hvilken legitimasjon en kommando bruker#

En kommando trenger en API-nøkkel og en URL. Den henter hver av de to fra det første av disse stedene som har den:

Du kan altså blande dem: for eksempel en API-nøkkel fra en miljøvariabel med URL-en til den gjeldende konteksten. Miljøvariabler passer for skript og CI-jobber, som ikke har lagrede kontekster:

export STATUS200_API_KEY=<api-key>
export STATUS200_URL=https://status200.ru
status200 incident list

export STATUS200_API_KEY=<api-key>
export STATUS200_URL=https://status200.ru
status200 incident list

$env:STATUS200_API_KEY = "<api-key>"
$env:STATUS200_URL = "https://status200.ru"
status200 incident list

Flagg går foran alt annet, for én kommando:

status200 --api-key <api-key> --url https://status200.ru incident list

Sjekk hva CLI-en vil bruke#

status200 whoami viser URL-en og API-nøkkelen som neste kommando vil bruke, og konteksten de kommer fra:

status200 whoami

URL:     https://status200.ru
API Key: 4f1c****0a13
Context: production

Bare de fire første og de fire siste tegnene i nøkkelen vises. Linjen Context vises bare når URL-en og nøkkelen er kontekstens egne, ikke verdier som et flagg eller en miljøvariabel har erstattet. whoami leser innstillingene dine uten å kalle Status200: den viser hva en kommando vil sende, ikke om Status200 godtar det. Er ingenting lagret eller satt, svarer den:

Not authenticated. Run `status200 login` to authenticate.

Konfigurasjonsfilen#

status200 login lagrer kontekster i ~/.oneuptime/config.json, i hjemmemappen din (%USERPROFILE%\.oneuptime\config.json på Windows). CLI-en oppretter den slik at bare brukeren din kan lese og skrive den (modus 0600):

{
  "currentContext": "production",
  "contexts": {
    "production": {
      "name": "production",
      "apiUrl": "https://status200.ru",
      "apiKey": "<api-key>"
    },
    "staging": {
      "name": "staging",
      "apiUrl": "https://status200.example.com",
      "apiKey": "<api-key>"
    }
  }
}

Filen inneholder API-nøklene som de er: hold den unna delte mapper, sikkerhetskopier og repositorier. For å logge ut av én kontekst sletter du den med status200 context delete <name>; for å logge ut av alle sletter du filen. En nøkkel som kan ha lekket, er gyldig til du sletter den i Status200, under Prosjektinnstillinger → Avansert → API-nøkler.

Utdataformater og listestørrelser lagres ikke her: gi -o og --limit til hver kommando.

Feilsøking#

Neste steg#