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

Mô tả bảng API

Tài liệu tham chiếu cho tất cả các bảng API của VergeOS với mô tả ngắn gọn, bao gồm các tài nguyên như billing, catalog, cluster, certificate, máy, ổ đĩa, NIC, snapshot và nhiều hơn nữa.

Sau đây là mô tả ngắn gọn về từng bảng API. Để biết thêm chi tiết, thêm /#swagger vào cuối URL VergeUI của bạn (hoặc điều hướng đến System->API Documentation). Swagger cung cấp thông tin chi tiết về từng bảng và cho phép bạn kiểm tra từng phương thức với hành động Get/Post/Put/Delete. Để biết thêm hướng dẫn về cách tích hợp với API, hãy tham khảo API Documentation trang.

Bảng API

auth_source_states

Cung cấp danh sách các trạng thái nguồn xác thực.

auth_sources

Bảng nguồn ủy quyền để quản lý các nguồn ủy quyền như OpenID hoặc AzureAD.

billing

Được dùng để lấy thông tin thanh toán cho môi trường hiện tại. Dữ liệu này được lưu dưới dạng dữ liệu thanh toán với ngày từ->đến.

billing_actions

Được dùng để gửi các hành động thanh toán. Hành động chính là "generate", hành động này tạo ra một hóa đơn mới.

  • Trường:

    • action : Xem danh sách hành động bên dưới.

  • Hành động:

    • generate : Tạo hóa đơn

  • Ví dụ:

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

catalog_logs

Nhật ký cụ thể cho Catalog.

catalog_repositories

Các kho Catalog và danh sách con cho catalog, nhật ký, quyền, v.v.

catalog_repository_actions

Được dùng để gửi các hành động của kho Catalog.

  • Trường:

    • repository : ID hàng của kho bạn muốn làm mới.

    • action : Hành động mặc định là làm mới. Xem danh sách hành động bên dưới.

  • Hành động:

    • refresh : Làm mới Kho Catalog.

  • Ví dụ:

catalog_repository_logs

Xem và đăng nhật ký Kho Catalog.

catalog_repository_status

Được dùng để lưu và cập nhật trạng thái Kho Catalog. Những trạng thái này xác định trạng thái và tình trạng của một Kho Catalog.

catalogs

Bảng Catalog cho phép bạn cập nhật/đăng/xóa Catalog.

certificates

Chứng chỉ SSL cho trang web của bạn.

clone_iso

Lưu trữ thông tin và trạng thái của chương trình Clone ISO của Verge.io.

clone_iso_actions

Các hành động cho tính năng Clone ISO.

  • Trường:

    • action : Mặc định là "update." Xem danh sách hành động bên dưới.

  • Hành động:

    • update : Cập nhật ảnh ISO.

    • delete : Xóa ảnh ISO.

    • cancel : Hủy bản dựng hiện tại.

  • Ví dụ:

cloud_restore

Lưu trữ thông tin khi thực hiện Cloud Restore.

cloud_snapshot_actions

Các hành động cho tính năng System Snapshot.

cloud_snapshot_tenant_actions

Các hành động cho tính năng System Snapshot dành cho Tenant.

cloud_snapshot_tenants

System Snapshot cho Tenant.

cloud_snapshot_vm_actions

Các hành động cho VM và System Snapshot.

cloud_snapshot_vms

Được dùng để lưu thông tin khi một System Snapshot được tải xuống VM.

cloud_snapshots

Bảng System Snapshot bao gồm thông tin về System Snapshot, cùng với danh sách các VM, Tenant và Sync Queue. Điều này có thể dùng để xem những VM nào được bao gồm trong một System Snapshot.

cloudinit_files

Các thao tác cho tính năng Cloudinit Files.

cluster_actions

Cluster Actions được dùng để gửi các hành động cho Cluster.

  • Trường:

    • cluster : ID hàng của Cluster (bắt buộc).

    • action : Xem danh sách hành động bên dưới.

    • params : Các tham số được cung cấp ở dạng JSON (tùy chọn).

  • Hành động:

    • shutdown : Tắt Cluster.

    • cancel_shutdown : Hủy yêu cầu tắt hiện tại.

  • Ví dụ:

cluster_stats_history_long

Bảng cluster_stats_history_long lưu lịch sử thống kê Cluster trong thời gian dài.

cluster_stats_history_short

Bảng cluster_stats_history_short lưu thống kê Cluster trong thời gian ngắn, lưu các thống kê gần nhất để truy cập nhanh.

cluster_status

Xử lý trạng thái của tất cả các cluster.

cluster_tier_stats

Xử lý thống kê cho các tier vSAN của một cluster.

cluster_tier_stats_history_long

Lưu thống kê lịch sử cho các Tier của Cluster trong thời gian dài.

cluster_tier_stats_history_short

Lưu thống kê lịch sử cho các Tier của Cluster trong thời gian ngắn, lưu các thống kê gần nhất để truy cập nhanh.

cluster_tier_status

Được dùng cho trạng thái Tier của Cluster.

cluster_tiers

Lưu danh sách các Tier cho cluster.

clusters

Bảng chính cho dữ liệu về các Cluster.

file_actions

Bảng file_actions gửi các hành động với tệp.

  • Trường:

    • file : ID tệp từ bảng files (bắt buộc).

    • action : Xem danh sách hành động bên dưới.

    • params : Các tham số được cung cấp ở dạng JSON (tùy chọn).

  • Hành động:

    • overwrite : Ghi đè tệp.

    • add_link : Thêm liên kết tệp.

    • delete_link : Xóa liên kết tệp.

    • delete_reference : Xóa tham chiếu tệp.

  • Ví dụ:

files

Thông tin liên quan đến các tệp đã lưu trữ.

Xử lý các liên kết công khai cho tệp.

group_logs

Nhật ký liên quan đến nhóm.

groups

Bảng quản lý nhóm.

help_actions

Xử lý các hành động liên quan đến trợ giúp.

Bảng tìm kiếm cho tài liệu trợ giúp.

licenses

Xử lý giấy phép VergeOS.

logs

Xử lý nhật ký hệ thống.

machine_console

Xử lý các tương tác với console của máy.

machine_console_active

Theo dõi các phiên console máy đang hoạt động.

machine_console_active_chat

Theo dõi các tương tác chat trong các console máy đang hoạt động.

machine_device_gpu_stats_history_long

Lưu thống kê GPU lịch sử trong thời gian dài.

machine_device_gpu_stats_history_short

Lưu thống kê GPU lịch sử trong thời gian ngắn.

machine_device_settings_nvidia_vgpu

Xử lý cài đặt cho thiết bị Nvidia vGPU.

machine_device_settings_tpm

Xử lý cài đặt cho thiết bị TPM.

machine_device_stats

Theo dõi thống kê thiết bị.

machine_device_status

Theo dõi trạng thái thiết bị.

machine_devices

Bảng thông tin thiết bị của máy.

machine_drive_phys

Dữ liệu ổ đĩa vật lý cho máy.

machine_drive_stats

Thống kê ổ đĩa cho máy.

machine_drive_stats_history_long

Lưu thống kê ổ đĩa lịch sử trong thời gian dài.

machine_drive_stats_history_short

Lưu thống kê ổ đĩa lịch sử trong thời gian ngắn.

machine_drive_status

Theo dõi trạng thái ổ đĩa cho máy.

machine_drives

Bảng cho ổ đĩa máy.

machine_logs

Theo dõi nhật ký máy.

machine_nic_stats

Thống kê NIC cho máy.

machine_nic_stats_history_long

Thống kê NIC lịch sử trong thời gian dài.

machine_nic_stats_history_short

Thống kê NIC lịch sử trong thời gian ngắn.

machine_nic_status

Trạng thái NIC cho máy.

machine_nics

Bảng cho các NIC trong máy.

machine_snapshots

Theo dõi các snapshot của máy.

machine_stats

Thống kê chung cho máy.

machine_stats_history_long

Thống kê lịch sử cho máy trong thời gian dài.

machine_stats_history_short

Thống kê lịch sử cho máy trong thời gian ngắn.

machine_status

Theo dõi trạng thái cho máy.

machines

Bảng chính cho dữ liệu máy.


Thông tin tài liệu

  • Cập nhật lần cuối: 2024-08-29

  • Phiên bản vergeOS: 4.12.6

Cập nhật lần cuối

Nội dung này có hữu ích không?