Ir al contenido
Documentación
Visión general de la CLI

Visión general de la CLI

Ver como Markdown

La CLI de Status200, status200, gestiona su proyecto de Status200 desde una terminal o un script. Lista, lee, crea, cambia, elimina y cuenta monitores, incidentes, alertas, páginas de estado y los demás registros que ofrece la API de Status200, con una clave de API de su proyecto.

Cómo funciona la CLIUn comando, una solicitud a la API, una respuesta.Instalar la CLIUn comando de npm, y la versión que elegir.Ejecutar sus primeros comandosGuarde su clave de API y luego liste sus incidentes.Los comandos de un vistazoCada comando, y la página que lo explica.

Cómo funciona la CLI

Cada comando envía una solicitud a la API REST de Status200 e imprime la respuesta. La CLI toma la clave de API y la dirección de su Status200 de opciones, variables de entorno o un contexto que guardó status200 login. La clave decide qué puede leer y cambiar un comando, exactamente igual que en la API.

flowchart TB T["Su terminal<br/>o un trabajo de CI"] -->|"status200 incident list"| C["CLI status200"] K["La clave de API<br/>y la URL: opciones,<br/>entorno o un<br/>contexto guardado"] --> C C -->|"POST /api/incident/get-list"| A["API REST de Status200"] A -->|"los registros que la<br/>clave puede leer,<br/>en JSON"| C C -->|"una tabla en<br/>una terminal,<br/>JSON en una tubería"| T

Un comando, una solicitud

Los comandos de los registros vienen con la CLI: cada tipo de registro que la API de Status200 abre a las herramientas tiene uno, los mismos registros para los que el servidor MCP tiene herramientas. Ejecute status200 resources para listarlos.

Antes de empezar

  • Node.js y npm, en una versión LTS actual, para instalar la CLI.
  • Una clave de API de su proyecto. Cree una en Ajustes del proyecto → Avanzado → Claves de API con Crear Clave de API: consulte Crear una clave de API.
  • En Status200 Cloud, el plan Growth o superior. Las claves de API de un proyecto solo funcionan con él: consulte Claves de API y SCIM por debajo de su plan.

Instalar la CLI

Instale el paquete @status200/cli desde npm. Añade el comando status200, y --version imprime la versión que instaló:

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

La CLI se publica junto con Status200 y tiene el mismo número de versión. En un Status200 autoalojado, instale la CLI de la versión de su Status200, para que sus comandos coincidan con los registros que tiene su servidor:

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

Ejecutar sus primeros comandos

  1. Guardar su clave de API

    Inicie sesión con la clave y la dirección de su Status200. La CLI las guarda como un contexto llamado default y lo usa a partir de ahora:

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

    Responde Logged in successfully. Context "default" is now active. En un Status200 autoalojado, use su dirección en lugar de https://status200.ru.

  2. Listar sus incidentes

    Bash 
    status200 incident list

    Los diez incidentes más recientes aparecen como una tabla. login guarda la clave sin comprobarla, así que este es el primer comando que muestra que la clave funciona: si se rechaza, consulte Solución de problemas.

  3. Ver qué más puede gestionar

    Bash 
    status200 resources

    La lista muestra cada tipo de registro con el que puede trabajar, y su comando, como monitor, status-page u on-call-policy.

Los comandos de un vistazo

ComandoQué haceMás información
status200 login <api-key> <instance-url>Guarda una clave de API y una dirección como contextoAutenticación
status200 context list, use, current, deleteLista, cambia, muestra y elimina contextos guardadosAutenticación
status200 whoamiMuestra la URL y la clave de API que usará el siguiente comandoAutenticación
status200 deployRegistra un despliegue, u otro cambio, para los gráficos y Status200 AIDespliegues y cambios
status200 <resource> list, get, create, update, delete, countTrabaja con un tipo de registroOperaciones de recursos
status200 resourcesLista los tipos de registro, con sus comandosReferencia de comandos
status200 versionImprime la versión de la CLIReferencia de comandos
status200 help [command]Muestra la ayuda de un comandoObtener ayuda

Opciones globales

Estas opciones funcionan con cada comando, antes o después de él:

OpciónQué hace
--api-key <key>La clave de API para este comando, en lugar de la guardada
--url <url>La dirección de su Status200 para este comando
--context <name>Un contexto guardado para este comando, en lugar del actual
-o, --output <format>table, json o wide: consulte Formatos de salida
--no-colorImprime sin colores
-V, --versionImprime la versión de la CLI
-h, --helpMuestra la ayuda del comando

Obtener ayuda

Cada comando tiene su propia ayuda, con sus argumentos, opciones y valores predeterminados:

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

Próximos pasos

AutenticaciónContextos para cada entorno, y qué clave usa un comando.Operaciones de recursosListar, leer, crear, cambiar, eliminar y contar registros.Formatos de salidaTablas para las personas, JSON para los scripts.Scripts y CI/CDCódigos de salida, jq y pipelines.Referencia de comandosCada comando, opción y valor predeterminado.