Autenticación

Cada solicitud que envía la CLI lleva una clave de API de su proyecto. Guarde las claves una vez con status200 login, un contexto para cada entorno, o páselas a un comando en opciones o variables de entorno, como hacen los scripts. Esta página muestra cada forma, y cuál usa un comando cuando hay varias.

Antes de empezar#

Necesita una clave de API de su proyecto. Cree una en Ajustes del proyecto → Avanzado → Claves de API con Crear Clave de API, y dele el acceso que necesitan sus comandos: consulte Crear una clave de API. Una clave hace lo que sus permisos permiten: una clave que solo puede leer registros puede listarlos y leerlos, pero no cambiarlos.

En Status200 Cloud, las claves de API solo funcionan mientras el proyecto está en el plan Growth o superior. Por debajo, cada comando responde API error (402) con un mensaje que nombra el plan, hasta que el proyecto se mejora; entonces la misma clave vuelve a funcionar. Consulte Claves de API y SCIM por debajo de su plan.

Iniciar sesión#

status200 login guarda una clave de API y la dirección de su Status200 como contexto, y lo convierte en el contexto actual:

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

Por ejemplo, un contexto llamado production:

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

Responde Logged in successfully. Context "production" is now active. Una barra al final de la dirección se elimina, y volver a iniciar sesión con el mismo nombre reemplaza ese contexto.

Contextos#

Un contexto es un inicio de sesión guardado: un nombre, una dirección y una clave de API. Guarde uno para cada proyecto o entorno y luego elija uno para todos los comandos que siguen, o para un solo comando.

1. Guardar un contexto para cada entorno#

   Bash

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

   Cada inicio de sesión convierte su contexto en el actual, así que ahora el actual es staging.

2. Listarlos#

   Bash

   status200 context list

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

   El * marca el contexto actual. Las claves de API nunca se listan.

3. Cambiar a otro contexto#

   Bash

   status200 context use production

   Responde Switched to context "production". y los comandos que siguen lo usan.

4. Usar un contexto para un solo comando#

   Bash

   status200 incident list --context staging

   El contexto actual queda como estaba.

Qué credenciales usa un comando#

Un comando necesita una clave de API y una URL. Toma cada una de las dos del primero de estos lugares que la tenga:

Así que puede combinarlos: por ejemplo, una clave de API de una variable de entorno con la URL del contexto actual. Las variables de entorno se adaptan a los scripts y a los trabajos de CI, que no tienen contextos guardados:

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

Las opciones van antes que todo lo demás, para un solo comando:

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

Comprobar qué usará la CLI#

status200 whoami muestra la URL y la clave de API que usará el siguiente comando, y el contexto del que proceden:

status200 whoami

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

Solo se muestran los cuatro primeros y los cuatro últimos caracteres de la clave. La línea Context aparece solo cuando la URL y la clave son las del propio contexto, no valores que una opción o una variable de entorno reemplazó. whoami lee su configuración sin llamar a Status200: muestra lo que enviará un comando, no si Status200 lo acepta. Sin nada guardado ni definido, responde:

Not authenticated. Run `status200 login` to authenticate.

El archivo de configuración#

status200 login guarda los contextos en ~/.oneuptime/config.json, en su carpeta de inicio (%USERPROFILE%\.oneuptime\config.json en Windows). La CLI lo crea de modo que solo su usuario pueda leerlo y escribirlo (modo 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>"
    }
  }
}

El archivo contiene las claves de API tal cual: manténgalo fuera de carpetas compartidas, copias de seguridad y repositorios. Para cerrar la sesión de un contexto, elimínelo con status200 context delete <name>; para cerrar la de todos, elimine el archivo. Una clave que pueda haberse filtrado sigue siendo válida hasta que la elimine en Status200, en Ajustes del proyecto → Avanzado → Claves de API.

Los formatos de salida y los tamaños de lista no se guardan aquí: pase -o y --limit a cada comando.

Solución de problemas#

Próximos pasos#