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

Descripción de las tablas de la API

Una referencia de todas las tablas de la API de VergeOS con descripciones breves, que cubre recursos como facturación, catálogos, clústeres, certificados, máquinas, discos, NIC, instantáneas y más.

La siguiente es una breve descripción de cada una de las tablas de la API. Para obtener más detalles, añada /#swagger al final de la URL de VergeUI (o navegue a Sistema->Documentación de la API). Swagger proporciona información detallada sobre cada tabla y le permite probar cada método con una acción Get/Post/Put/Delete. Para obtener más instrucciones sobre cómo integrarse con la API, consulte la página de Documentación de la API .

Tablas de la API

auth_source_states

Proporciona una lista de estados de origen de autenticación.

auth_sources

Tabla de orígenes de autorización para gestionar orígenes de autorización como OpenID o AzureAD.

billing

Se utiliza para obtener información de facturación del entorno actual. Esto se almacena como datos de facturación con una fecha de inicio y fin.

billing_actions

Se utiliza para enviar acciones de facturación. La acción principal es "generate", que crea una nueva factura.

  • Campos:

    • action : Consulte la lista de acciones a continuación.

  • Acciones:

    • generate : Generar factura

  • Ejemplo:

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

catalog_logs

Registros específicos de los catálogos.

catalog_repositories

Repositorios de catálogos y sublistas para catálogos, registros, permisos, etc.

catalog_repository_actions

Se utiliza para enviar acciones de repositorio de catálogo.

  • Campos:

    • repository : ID de fila del repositorio que desea actualizar.

    • action : La acción predeterminada es refresh. Consulte la lista de acciones a continuación.

  • Acciones:

    • refresh : Actualizar el repositorio de catálogo.

  • Ejemplo:

catalog_repository_logs

Ver y publicar registros del repositorio de catálogo.

catalog_repository_status

Se utiliza para almacenar y actualizar los estados del repositorio de catálogo. Estos determinan el estado y la situación de un repositorio de catálogo.

catalogs

Tabla de catálogos que le permite actualizar/publicar/eliminar catálogos.

certificates

Certificados SSL para su sitio.

clone_iso

Almacena información y estado del programa Verge.io Clone ISO.

clone_iso_actions

Acciones para la función Clone ISO.

  • Campos:

    • action : El valor predeterminado es "update". Consulte la lista de acciones a continuación.

  • Acciones:

    • update : Actualizar la imagen ISO.

    • delete : Eliminar la imagen ISO.

    • cancel : Cancelar la compilación actual.

  • Ejemplo:

cloud_restore

Almacena información cuando se realiza una restauración en la nube.

cloud_snapshot_actions

Acciones para la función Instantánea del sistema.

cloud_snapshot_tenant_actions

Acciones para la función Instantánea del sistema para un inquilino.

cloud_snapshot_tenants

Instantáneas del sistema para un inquilino.

cloud_snapshot_vm_actions

Acciones para una VM e instantáneas del sistema.

cloud_snapshot_vms

Se utiliza para almacenar información cuando se descarga una instantánea del sistema a una VM.

cloud_snapshots

La tabla de instantáneas del sistema incluye información sobre la instantánea del sistema, así como una lista de VMs, inquilinos y colas de sincronización. Esto puede utilizarse para ver qué VMs están incluidas en una instantánea del sistema.

cloudinit_files

Operaciones para la función de archivos Cloudinit.

cluster_actions

Cluster Actions se utiliza para enviar acciones para clústeres.

  • Campos:

    • cluster : ID de fila del clúster (obligatorio).

    • action : Consulte la lista de acciones a continuación.

    • params : Parámetros proporcionados en forma JSON (opcional).

  • Acciones:

    • shutdown : Apagar el clúster.

    • cancel_shutdown : Cancelar la solicitud de apagado actual.

  • Ejemplo:

cluster_stats_history_long

La tabla cluster_stats_history_long contiene el historial de estadísticas del clúster durante períodos prolongados.

cluster_stats_history_short

La tabla cluster_stats_history_short contiene estadísticas del clúster durante un período corto, almacenando las estadísticas más recientes para un acceso rápido.

cluster_status

Gestiona el estado de todos los clústeres.

cluster_tier_stats

Gestiona las estadísticas de los niveles vSAN de un clúster.

cluster_tier_stats_history_long

Contiene estadísticas históricas de los niveles de clúster durante períodos prolongados.

cluster_tier_stats_history_short

Contiene estadísticas históricas de los niveles de clúster durante períodos cortos, almacenando las estadísticas más recientes para un acceso rápido.

cluster_tier_status

Se utiliza para los estados de los niveles de clúster.

cluster_tiers

Contiene una lista de niveles para el clúster.

clusters

La tabla principal para los datos de los clústeres.

file_actions

La tabla file_actions envía acciones sobre archivos.

  • Campos:

    • file : ID de archivo de la tabla files (obligatorio).

    • action : Consulte la lista de acciones a continuación.

    • params : Parámetros proporcionados en forma JSON (opcional).

  • Acciones:

    • overwrite : Sobrescribir el archivo.

    • add_link : Añadir un enlace al archivo.

    • delete_link : Eliminar un enlace al archivo.

    • delete_reference : Eliminar referencias de archivo.

  • Ejemplo:

files

Información relacionada con los archivos almacenados.

Gestiona enlaces públicos para archivos.

group_logs

Registros relacionados con grupos.

groups

Tabla de gestión de grupos.

help_actions

Gestiona acciones relacionadas con la ayuda.

Tabla de búsqueda para la documentación de ayuda.

licenses

Gestiona las licencias de VergeOS.

logs

Gestiona los registros del sistema.

machine_console

Gestiona las interacciones de la consola de la máquina.

machine_console_active

Rastrea sesiones activas de la consola de la máquina.

machine_console_active_chat

Rastrea interacciones de chat en consolas de máquina activas.

machine_device_gpu_stats_history_long

Contiene estadísticas históricas de GPU durante períodos prolongados.

machine_device_gpu_stats_history_short

Contiene estadísticas históricas de GPU durante períodos cortos.

machine_device_settings_nvidia_vgpu

Gestiona la configuración de dispositivos Nvidia vGPU.

machine_device_settings_tpm

Gestiona la configuración de dispositivos TPM.

machine_device_stats

Rastrea estadísticas de dispositivos.

machine_device_status

Rastrea el estado de los dispositivos.

machine_devices

Tabla para información de dispositivos de máquina.

machine_drive_phys

Datos de unidades físicas para máquinas.

machine_drive_stats

Estadísticas de unidades para máquinas.

machine_drive_stats_history_long

Contiene estadísticas históricas de unidades durante períodos prolongados.

machine_drive_stats_history_short

Contiene estadísticas históricas de unidades durante períodos cortos.

machine_drive_status

Rastrea el estado de las unidades para máquinas.

machine_drives

Tabla para unidades de máquina.

machine_logs

Rastrea los registros de la máquina.

machine_nic_stats

Estadísticas de NIC para máquinas.

machine_nic_stats_history_long

Estadísticas históricas de NIC durante períodos largos.

machine_nic_stats_history_short

Estadísticas históricas de NIC durante períodos cortos.

machine_nic_status

Estado de NIC para máquinas.

machine_nics

Tabla para NICs en máquinas.

machine_snapshots

Rastrea instantáneas para máquinas.

machine_stats

Estadísticas generales para máquinas.

machine_stats_history_long

Estadísticas históricas para máquinas durante períodos prolongados.

machine_stats_history_short

Estadísticas históricas para máquinas durante períodos cortos.

machine_status

Rastrea el estado de las máquinas.

machines

Tabla principal para los datos de la máquina.


Información del documento

  • Última actualización: 2024-08-29

  • Versión de vergeOS: 4.12.6

Última actualización

¿Te fue útil?