For the complete documentation index, see llms.txt. This page is also available as Markdown.

Description des tables API

Référence de toutes les tables API VergeOS avec de brèves descriptions, couvrant des ressources telles que la facturation, les catalogues, les clusters, les certificats, les machines, les disques, les NIC, les snapshots, et plus encore.

Voici une brève description de chacune des tables API. Pour plus de détails, ajoutez /#swagger à la fin de l’URL de votre VergeUI (ou accédez à Système->Documentation API). Swagger fournit des informations détaillées sur chaque table et vous permet de tester chaque méthode avec une action Get/Post/Put/Delete. Pour plus d’instructions sur l’intégration avec l’API, reportez-vous à la Documentation API page.

Tables API

auth_source_states

Fournit une liste des états des sources d’authentification.

auth_sources

Table des sources d’autorisation pour gérer des sources d’autorisation comme OpenID ou AzureAD.

billing

Utilisé pour obtenir les informations de facturation de l’environnement actuel. Celles-ci sont stockées sous forme de données de facturation avec une date de début -> date de fin.

billing_actions

Utilisé pour envoyer des actions de facturation. L’action principale est "generate", qui crée une nouvelle facture.

  • Champs :

    • action : Voir la liste des actions ci-dessous.

  • Actions :

    • generate : Générer la facture

  • Exemple :

    URL : '/v4/billing_actions'
    POST(JSON) : {"action": "generate"}

catalog_logs

Journaux spécifiques aux catalogues.

catalog_repositories

Dépôts de catalogues et sous-listes pour les catalogues, journaux, permissions, etc.

catalog_repository_actions

Utilisé pour envoyer des actions de dépôt de catalogue.

  • Champs :

    • repository : ID de ligne du dépôt que vous souhaitez actualiser.

    • action : L’action par défaut est refresh. Voir la liste des actions ci-dessous.

  • Actions :

    • refresh : Actualiser le dépôt de catalogue.

  • Exemple :

catalog_repository_logs

Afficher et publier les journaux du dépôt de catalogue.

catalog_repository_status

Utilisé pour stocker et mettre à jour les statuts du dépôt de catalogue. Ceux-ci déterminent l’état et le statut d’un dépôt de catalogue.

catalogs

Table des catalogues permettant de mettre à jour, publier ou supprimer des catalogues.

certificates

Certificats SSL pour votre site.

clone_iso

Stocke les informations et l’état du programme Clone ISO de Verge.io.

clone_iso_actions

Actions pour la fonctionnalité Clone ISO.

  • Champs :

    • action : La valeur par défaut est "update". Voir la liste des actions ci-dessous.

  • Actions :

    • update : Mettre à jour l’image ISO.

    • delete : Supprimer l’image ISO.

    • cancel : Annuler la génération en cours.

  • Exemple :

cloud_restore

Stocke les informations lorsqu’une restauration cloud est effectuée.

cloud_snapshot_actions

Actions pour la fonctionnalité d’instantané système.

cloud_snapshot_tenant_actions

Actions pour la fonctionnalité d’instantané système pour un locataire.

cloud_snapshot_tenants

Instantanés système pour un locataire.

cloud_snapshot_vm_actions

Actions pour une VM et les instantanés système.

cloud_snapshot_vms

Utilisé pour stocker des informations lorsqu’un instantané système est téléchargé vers une VM.

cloud_snapshots

La table des instantanés système comprend des informations sur l’instantané système, ainsi qu’une liste de VM, de locataires et de files de synchronisation. Cela peut être utilisé pour voir quelles VM sont incluses dans un instantané système.

cloudinit_files

Opérations pour la fonctionnalité Cloudinit Files.

cluster_actions

Cluster Actions est utilisé pour envoyer des actions pour les clusters.

  • Champs :

    • cluster : ID de ligne du cluster (obligatoire).

    • action : Voir la liste des actions ci-dessous.

    • params : Paramètres fournis au format JSON (facultatif).

  • Actions :

    • shutdown : Arrêter le cluster.

    • cancel_shutdown : Annuler la demande d’arrêt en cours.

  • Exemple :

cluster_stats_history_long

La table cluster_stats_history_long conserve l’historique des statistiques du cluster sur de longues périodes.

cluster_stats_history_short

La table cluster_stats_history_short conserve les statistiques du cluster sur une courte période, en stockant les statistiques les plus récentes pour un accès rapide.

cluster_status

Gère l’état de tous les clusters.

cluster_tier_stats

Gère les statistiques des niveaux vSAN d’un cluster.

cluster_tier_stats_history_long

Conserve des statistiques historiques pour les niveaux de cluster sur de longues périodes.

cluster_tier_stats_history_short

Conserve des statistiques historiques pour les niveaux de cluster sur de courtes périodes, en stockant les statistiques les plus récentes pour un accès rapide.

cluster_tier_status

Utilisé pour les statuts des niveaux de cluster.

cluster_tiers

Conserve une liste des niveaux pour le cluster.

clusters

La table principale des données sur les clusters.

file_actions

La table file_actions envoie des actions sur les fichiers.

  • Champs :

    • file : ID du fichier de la table files (obligatoire).

    • action : Voir la liste des actions ci-dessous.

    • params : Paramètres fournis au format JSON (facultatif).

  • Actions :

    • overwrite : Écraser le fichier.

    • add_link : Ajouter un lien de fichier.

    • delete_link : Supprimer un lien de fichier.

    • delete_reference : Supprimer les références du fichier.

  • Exemple :

files

Informations liées aux fichiers stockés.

Gère les liens publics pour les fichiers.

group_logs

Journaux liés aux groupes.

groups

Table de gestion des groupes.

help_actions

Gère les actions liées à l’aide.

Table de recherche pour la documentation d’aide.

licenses

Gère les licences VergeOS.

logs

Gère les journaux système.

machine_console

Gère les interactions de la console machine.

machine_console_active

Suit les sessions de console machine actives.

machine_console_active_chat

Suit les interactions de chat dans les consoles machine actives.

machine_device_gpu_stats_history_long

Conserve des statistiques historiques du GPU sur de longues périodes.

machine_device_gpu_stats_history_short

Conserve des statistiques historiques du GPU sur de courtes périodes.

machine_device_settings_nvidia_vgpu

Gère les paramètres des périphériques Nvidia vGPU.

machine_device_settings_tpm

Gère les paramètres des périphériques TPM.

machine_device_stats

Suit les statistiques des périphériques.

machine_device_status

Suit l’état des périphériques.

machine_devices

Table des informations sur les périphériques des machines.

machine_drive_phys

Données des disques physiques pour les machines.

machine_drive_stats

Statistiques des disques pour les machines.

machine_drive_stats_history_long

Conserve des statistiques historiques des disques sur de longues périodes.

machine_drive_stats_history_short

Conserve des statistiques historiques des disques sur de courtes périodes.

machine_drive_status

Suit l’état des disques pour les machines.

machine_drives

Table des disques des machines.

machine_logs

Suit les journaux des machines.

machine_nic_stats

Statistiques NIC pour les machines.

machine_nic_stats_history_long

Statistiques historiques NIC sur de longues périodes.

machine_nic_stats_history_short

Statistiques historiques NIC sur de courtes périodes.

machine_nic_status

État des NIC pour les machines.

machine_nics

Table des NIC dans les machines.

machine_snapshots

Suit les instantanés des machines.

machine_stats

Statistiques générales des machines.

machine_stats_history_long

Statistiques historiques des machines sur de longues périodes.

machine_stats_history_short

Statistiques historiques des machines sur de courtes périodes.

machine_status

Suit l’état des machines.

machines

Table principale des données des machines.


Informations sur le document

  • Dernière mise à jour : 2024-08-29

  • Version de vergeOS : 4.12.6

Mis à jour

Ce contenu vous a-t-il été utile ?