Aller au contenu
Référence des commandes

Référence des commandes

Voir en Markdown

Chaque commande de la CLI status200, avec ses arguments, ses options et ses valeurs par défaut. Ajoutez --help à n'importe quelle commande pour voir la même chose dans votre terminal.

Les commandes

flowchart LR O["status200"] --> L["login"] O --> C["context"] C --> C1["list<br/>use<br/>current<br/>delete"] O --> R["incident, monitor<br/>et chaque ressource"] R --> R1["list<br/>get<br/>create<br/>update<br/>delete<br/>count"] O --> U["deploy<br/>whoami<br/>resources<br/>version<br/>help"]

Les commandes de la CLI status200

Options globales

OptionCe qu'elle faitPar défaut
--api-key <key>La clé API pour cette commandeSTATUS200_API_KEY, puis la clé du contexte
--url <url>L'adresse de votre Status200 pour cette commandeSTATUS200_URL, puis l'URL du contexte
--context <name>Le contexte enregistré à utiliser pour cette commandeLe contexte actuel
-o, --output <format>json, table ou widetable dans un terminal, json dans un pipe
--no-colorAffiche sans couleursDes couleurs, sauf si NO_COLOR est défini
-V, --versionAffiche la version de la CLI
-h, --helpAffiche l'aide d'une commande

Les options se placent avant ou après la commande : status200 --context staging incident list et status200 incident list --context staging font la même chose.

Connexion et contextes

status200 login

Enregistre une clé API et une adresse comme contexte, et en fait le contexte actuel. Voir Se connecter.

Bash
status200 login <api-key> <instance-url> [--context-name <name>]
Argument ou optionObligatoireCe que c'estPar défaut
<api-key>OuiUne clé API de votre projet
<instance-url>OuiL'adresse de votre Status200, comme https://status200.ru
--context-name <name>NonLe nom sous lequel enregistrer le contextedefault

status200 context list

Liste les contextes enregistrés ; * marque l'actuel. Les clés API ne sont jamais listées.

Bash
status200 context list [-o <format>]
OptionObligatoireCe que c'est
-o, --output <format>Nonjson, table ou wide. Le JSON donne le name, l'apiUrl et le isCurrent de chaque contexte

status200 context use

Fait d'un contexte enregistré le contexte actuel.

Bash
status200 context use <name>
ArgumentObligatoireCe que c'est
<name>OuiLe nom d'un contexte enregistré

status200 context current

Affiche le nom et l'URL du contexte actuel, et sa clé API masquée sauf ses quatre premiers et quatre derniers caractères.

Bash
status200 context current

status200 context delete

Supprime un contexte enregistré. Si c'était le contexte actuel, le premier contexte restant devient l'actuel.

Bash
status200 context delete <name>
ArgumentObligatoireCe que c'est
<name>OuiLe nom d'un contexte enregistré

Commandes des ressources

<resource> est la commande d'un type d'enregistrement, tirée des tableaux Ressources, comme incident ou monitor. Voir Opérations sur les ressources pour des exemples.

status200 <resource> list

Liste des enregistrements, les plus récents d'abord. Les étiquettes sont plutôt listées par nom, les étiquettes numérotées d'abord (2. Team avant 10. Owner).

Bash
status200 <resource> list [--query <json>] [--limit <n>] [--skip <n>] [--sort <json>] [-o <format>]
OptionCe qu'elle faitPar défaut
--query <json>Un filtre, en JSONChaque enregistrement que la clé peut lire
--limit <n>Le nombre maximal d'enregistrements à renvoyer, jusqu'à 10 00010
--skip <n>Combien d'enregistrements passer d'abord0
--sort <json>L'ordre, en JSON : {"<field>":"ASC"} ou {"<field>":"DESC"}Les plus récents d'abord
-o, --output <format>json, table ou widetable dans un terminal, json dans un pipe

status200 <resource> get

Lit un enregistrement. Enregistrements seulement : la télémétrie n'a pas de get.

Bash
status200 <resource> get <id> [-o <format>]
Argument ou optionObligatoireCe que c'est
<id>OuiL'ID de l'enregistrement, un UUID
-o, --output <format>Nonjson, table ou wide

status200 <resource> create

Crée un enregistrement et l'affiche.

Bash
status200 <resource> create (--data <json> | --file <path>) [-o <format>]
OptionObligatoireCe que c'est
--data <json>L'une des deuxL'enregistrement, en JSON
--file <path>L'une des deuxUn fichier JSON contenant l'enregistrement. Donné avec --data, c'est le fichier qui est utilisé
-o, --output <format>Nonjson, table ou wide

status200 <resource> update

Modifie les champs que vous donnez. Enregistrements seulement : la télémétrie n'a pas d'update.

Bash
status200 <resource> update <id> --data <json> [-o <format>]
Argument ou optionObligatoireCe que c'est
<id>OuiL'ID de l'enregistrement
--data <json>OuiLes champs à modifier, en JSON
-o, --output <format>Nonjson, table ou wide

status200 <resource> delete

Supprime un enregistrement immédiatement, sans demander. Enregistrements seulement : la télémétrie n'a pas de delete.

Bash
status200 <resource> delete <id> [--force]
Argument ou optionObligatoireCe que c'est
<id>OuiL'ID de l'enregistrement
--forceNonAccepté et ne change rien : delete ne demande jamais de confirmation

status200 <resource> count

Compte des enregistrements et affiche le nombre.

Bash
status200 <resource> count [--query <json>] [-o <format>]
OptionObligatoireCe que c'est
--query <json>NonUn filtre, en JSON. Sans filtre, chaque enregistrement que la clé peut lire
-o, --output <format>Nonjson, table ou wide

Ressources

Les enregistrements prennent list, get, create, update, delete et count :

DomaineCommandes
Surveillancemonitor, monitor-status, monitor-status-event
Incidentsincident, incident-state, incident-severity, incident-state-timeline, incident-public-note, incident-internal-note, incident-alert, postmortem-status
Alertesalert, alert-state, alert-severity, alert-state-timeline, alert-internal-note
Pages de statutstatus-page, status-page-announcement
Maintenance planifiéescheduled-maintenance-event, scheduled-maintenance-state, scheduled-maintenance-state-timeline
Équipes et astreinteteam, on-call-policy
Sécuritésecurity-case, security-case-note, security-detection, security-playbook
Libelléslabel

La télémétrie prend list, create et count :

DomaineCommandes
Observabilitélog, metric, span, exception-instance, monitor-log
Sécuritésecurity-event, threat-intel-indicator
Changements et coûtschange-event, kubernetes-cost-allocation

La CLI sort en même temps que Status200 : status200 resources liste donc les commandes de la version que vous avez installée.

Requêtes à l'API

Chaque opération est une requête à l'API, avec la clé dans l'en-tête APIKey. <path> est le chemin d'API de la ressource, donné par status200 resources : /incident pour incident, /on-call-duty-policy pour on-call-policy.

OpérationRequêteCorps
listPOST /api/<path>/get-listquery, select, skip, limit et sort
getPOST /api/<path>/<id>/get-itemselect
createPOST /api/<path>{"data": ...}
updatePUT /api/<path>/<id>/{"data": ...}
deleteDELETE /api/<path>/<id>/Aucun
countPOST /api/<path>/countquery

Autres commandes

status200 deploy

Enregistre un déploiement, ou un autre changement, depuis un pipeline : il est dessiné sur les graphiques du service et lu par Status200 AI quand il investigue un incident. La commande écrit avec une clé d'ingestion de télémétrie, pas avec une clé API. Voir Déploiements et changements.

Bash
status200 deploy [--service <name>] [--service-version <version>] [--previous-version <version>] [--commit <sha>] [--repository <url>] [--branch <name>] [--pull-request <number>] [--environment <name>] [--title <title>] [--description <text>] [--type <type>] [--time <time>] [--attribute <key=value...>] [--ingestion-key <key>]
OptionObligatoireCe que c'estPar défaut
--service <name>NonLe service qui a été déployéUn changement qui concerne tout le projet
--service-version <version>NonLa version déployée
--previous-version <version>NonLa version qu'elle a remplacée
--commit <sha>NonLe commit déployé
--repository <url>NonLe dépôt où se trouve le commit
--branch <name>NonLa branche déployée
--pull-request <number>NonLa pull request déployée
--environment <name>NonL'environnement de déploiement
--title <title>NonLe titre du changement ; un autre type qu'un déploiement en a besoinDeploy <version>
--description <text>NonLes détails du changement
--type <type>NonLe type de changement, comme config-change ou rollbackdeployment
--time <time>NonQuand il a eu lieu, comme 2026-10-19T10:00:00ZMaintenant
--attribute <key=value...>NonD'autres attributs, sous la forme key=value, un ou plusieurs
--ingestion-key <key>NonUne clé d'ingestion de télémétrie du projetSTATUS200_TELEMETRY_INGESTION_KEY

status200 whoami

Affiche l'URL et la clé API que la prochaine commande utilisera, la clé masquée, et le contexte dont elles viennent. Elle n'appelle pas Status200. Voir Vérifier ce que la CLI va utiliser.

Bash
status200 whoami

status200 resources

Liste chaque type d'enregistrement pour lequel la CLI a une commande : sa commande, ses noms au singulier et au pluriel, son type et son chemin d'API, et le total.

Bash
status200 resources [--type <type>] [-o <format>]
OptionObligatoireCe que c'estPar défaut
--type <type>Nondatabase pour les enregistrements, analytics pour la télémétrieLes deux
-o, --output <format>Nonjson, table ou wide. Le JSON donne le name, le singularName, le pluralName, le modelType et l'apiPath de chacuntable dans un terminal, json dans un pipe

status200 version

Affiche la version de la CLI, comme le fait status200 --version.

Bash
status200 version

status200 help

Affiche l'aide de la CLI, ou celle d'une commande.

Bash
status200 help [command]

Variables d'environnement

VariableCe qu'elle fait
STATUS200_API_KEYLa clé API, quand aucune option --api-key n'en donne une
STATUS200_URLL'adresse de votre Status200, quand aucune option --url n'en donne une
STATUS200_TELEMETRY_INGESTION_KEYLa clé d'ingestion de télémétrie avec laquelle status200 deploy écrit, quand aucune option --ingestion-key n'en donne une
NO_COLORDéfinie avec n'importe quelle valeur, elle désactive les couleurs

Fichiers

FichierCe qu'il contient
~/.oneuptime/config.jsonLes contextes enregistrés, leurs clés API et le contexte actuel

Codes de sortie

CodeSignification
0Cela a fonctionné
1Cela a échoué : Status200 a refusé la requête, ou la commande était erronée
2Aucune clé API utilisable : aucune trouvée, non valide, ou sous son offre
3Introuvable : Status200 a répondu 404

Voir Codes de sortie pour des exemples.

Étapes suivantes