API 表说明
VergeOS 所有 API 表及其简要说明的参考，涵盖计费、目录、集群、证书、机器、磁盘、NIC、快照等资源。
以下是每个 API 表的简要说明。要了解更多详情，请添加 /#swagger 到 VergeUI 的 URL 末尾（或导航到 System->API Documentation）。Swagger 提供有关每个表的详细信息，并允许你使用 Get/Post/Put/Delete 操作测试每个方法。有关如何集成 API 的更多说明，请参阅 API Documentation 页面。
API 表
auth_source_states
提供认证源状态列表。
auth_sources
用于管理 OpenID 或 AzureAD 等授权源的授权源表。
billing
用于获取当前环境的账单信息。这些信息以带有起始日期和结束日期的账单数据形式存储。
billing_actions
用于发送账单操作。主要操作是“generate”，它会创建一张新账单。
字段：
action ：请参见下面的操作列表。
操作：
generate ：生成账单
示例：
URL: '/v4/billing_actions' POST(JSON): {"action": "generate"}
catalog_logs
与目录相关的日志。
catalog_repositories
目录、日志、权限等的目录仓库及子列表。
catalog_repository_actions
用于发送目录仓库操作。
字段：
repository ：要刷新的仓库的行 ID。
action ：默认操作为 refresh。请参见下面的操作列表。
操作：
refresh ：刷新目录仓库。
示例：
catalog_repository_logs
查看并发布目录仓库日志。
catalog_repository_status
用于存储和更新目录仓库状态。这些状态决定目录仓库的状态和情况。
catalogs
允许你更新/发布/删除目录的目录表。
certificates
你站点的 SSL 证书。
clone_iso
存储 Verge.io Clone ISO 程序的信息和状态。
Clone ISO 功能的操作。
：默认值为“update”。请参见下面的操作列表。
字段：
action ：默认值为“update”。请参见下面的操作列表。
操作：
update ：更新 ISO 镜像。
delete ：删除 ISO 镜像。
cancel ：取消当前构建。
示例：
cloud_restore
在执行云恢复时存储信息。
cloud_snapshot_actions
系统快照功能的操作。
cloud_snapshot_tenant_actions
租户系统快照功能的操作。
cloud_snapshot_tenants
租户的系统快照。
cloud_snapshot_vm_actions
VM 和系统快照的操作。
cloud_snapshot_vms
用于在系统快照下载到 VM 时存储信息。
cloud_snapshots
系统快照表包含有关系统快照的信息，以及 VM、租户和同步队列列表。可用于查看系统快照中包含哪些 VM。
cloudinit_files
Cloudinit 文件功能的操作。
cluster_actions
Cluster Actions 用于发送集群操作。
字段：
cluster ：集群行 ID（必需）。
action ：请参见下面的操作列表。
params ：以 JSON 形式提供的参数（可选）。
操作：
shutdown ：关闭集群。
cancel_shutdown ：取消当前关机请求。
示例：
cluster_stats_history_long
cluster_stats_history_long 表保存较长时间段的集群统计历史。
cluster_stats_history_short
cluster_stats_history_short 表保存短时间段的集群统计信息，存储最近的统计数据以便快速访问。
cluster_status
处理所有集群的状态。
cluster_tier_stats
处理集群的 vSAN 分层统计信息。
cluster_tier_stats_history_long
保存集群分层较长时间段的历史统计信息。
cluster_tier_stats_history_short
保存集群分层较短时间段的历史统计信息，存储最近的统计数据以便快速访问。
cluster_tier_status
用于集群分层状态。
cluster_tiers
保存集群的分层列表。
clusters
集群数据的主表。
file_actions
file_actions 表发送文件操作。
字段：
file ：files 表中的文件 ID（必需）。
action ：请参见下面的操作列表。
params ：以 JSON 形式提供的参数（可选）。
操作：
overwrite ：覆盖文件。
add_link ：添加文件链接。
delete_link ：删除文件链接。
delete_reference ：删除文件引用。
示例：
files
与已存储文件相关的信息。
files_public_links
处理文件的公共链接。
group_logs
与组相关的日志。
groups
组管理表。
help_actions
处理帮助相关操作。
help_search
帮助文档搜索表。
licenses
处理 VergeOS 许可证。
logs
处理系统日志。
machine_console
处理机器控制台交互。
machine_console_active
跟踪活跃的机器控制台会话。
machine_console_active_chat
跟踪活跃机器控制台中的聊天交互。
machine_device_gpu_stats_history_long
保存较长时间段的 GPU 历史统计信息。
machine_device_gpu_stats_history_short
保存较短时间段的 GPU 历史统计信息。
machine_device_settings_nvidia_vgpu
处理 Nvidia vGPU 设备设置。
machine_device_settings_tpm
处理 TPM 设备设置。
machine_device_stats
跟踪设备统计信息。
machine_device_status
跟踪设备状态。
machine_devices
机器设备信息表。
machine_drive_phys
机器的物理驱动器数据。
machine_drive_stats
机器的驱动器统计信息。
machine_drive_stats_history_long
保存较长时间段的驱动器历史统计信息。
machine_drive_stats_history_short
保存较短时间段的驱动器历史统计信息。
machine_drive_status
跟踪机器的驱动器状态。
machine_drives
机器驱动器表。
machine_logs
跟踪机器日志。
machine_nic_stats
机器的 NIC 统计信息。
machine_nic_stats_history_long
长期 NIC 历史统计信息。
machine_nic_stats_history_short
短期 NIC 历史统计信息。
machine_nic_status
机器的 NIC 状态。
machine_nics
机器中 NIC 的表。
machine_snapshots
跟踪机器快照。
machine_stats
机器的通用统计信息。
machine_stats_history_long
机器的长期历史统计信息。
machine_stats_history_short
机器的短期历史统计信息。
machine_status
跟踪机器状态。
machines
机器数据的主表。
最后更新于
这有帮助吗？