synology_apm.sdk.models.system module

SiteInfo, SiteStorageStats, WorkloadTypeStat, and WorkloadUsageSummary data models.

class synology_apm.sdk.models.system.SiteStorageStats(logical_backup_data_bytes, physical_backup_data_bytes)

Bases: object

Site-wide backup storage statistics.

Variables:

  • logical_backup_data_bytes (int) – Total logical backup data size (before dedup/compression).

  • physical_backup_data_bytes (int) – Physical storage occupied by backup data (after dedup/compression).

logical_backup_data_bytes: int
physical_backup_data_bytes: int
property backup_data_reduction_bytes: int

Data reduction achieved by dedup/compression in bytes. Minimum is 0.

property backup_data_reduction_ratio: float

Data reduction ratio as a percentage (float 0–100). Returns 0.0 when logical size is 0.

class synology_apm.sdk.models.system.WorkloadTypeStat(workload_type, total_count, protected_data_bytes)

Bases: object

Per-type workload count and data usage.

Variables:

  • workload_type (synology_apm.sdk.enums.WorkloadStatType) – Workload type.

  • total_count (int) – Total number of workloads (success + warning + error + no_backup).

  • protected_data_bytes (int) – Cumulative protected data size in bytes.

workload_type: WorkloadStatType
total_count: int
protected_data_bytes: int
class synology_apm.sdk.models.system.WorkloadUsageSummary(by_type)

Bases: object

Aggregated workload count and data usage across all workload types.

Variables:

by_type (tuple[synology_apm.sdk.models.system.WorkloadTypeStat, ...]) – Per-type statistics tuple.

by_type: tuple[WorkloadTypeStat, ...]
property total_count: int

Total number of workloads across all types.

property total_protected_data_bytes: int

Total protected data size in bytes across all types.

class synology_apm.sdk.models.system.SiteInfo(site_uuid, external_address, port, primary_management_server, secondary_management_server, site_storage, workload_usage)

Bases: object

Complete APM site information.

Variables:
site_uuid: str
external_address: str
port: str
primary_management_server: BackupServer | None
secondary_management_server: BackupServer | None
site_storage: SiteStorageStats
workload_usage: WorkloadUsageSummary