ExDaytona.Api.Usage (ex_daytona v0.2.0)

API calls for all endpoints tagged Usage.

Summary

Functions

get_organization_sandbox_usage(connection, organization_id, sandbox_id, from, to, opts \\ [])

Get sandbox usage periods Returns individual usage records for a specific sandbox within a time range

get_organization_usage_aggregated(connection, organization_id, from, to, opts \\ [])

Get aggregated usage Returns organization-level resource usage totals for a given time period

get_organization_usage_chart(connection, organization_id, from, to, opts \\ [])

Get usage chart data Returns resource usage data points for a given time period with auto-scaled resolution

get_organization_usage_per_sandbox(connection, organization_id, from, to, opts \\ [])

Get per-sandbox usage Returns resource usage aggregated per sandbox for a given time period

Functions

get_organization_sandbox_usage(connection, organization_id, sandbox_id, from, to, opts \\ [])

@spec get_organization_sandbox_usage(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, [ExDaytona.Model.ModelsUsagePeriod.t()]} | {:error, Tesla.Env.t()}

Get sandbox usage periods Returns individual usage records for a specific sandbox within a time range

Parameters

connection (ExDaytona.Connection): Connection to server
organization_id (String.t): Organization ID
sandbox_id (String.t): Sandbox ID
from (String.t): Start time (RFC3339)
to (String.t): End time (RFC3339)
opts (keyword): Optional parameters

Returns

{:ok, [%ModelsUsagePeriod{}, ...]} on success
{:error, Tesla.Env.t} on failure

get_organization_usage_aggregated(connection, organization_id, from, to, opts \\ [])

@spec get_organization_usage_aggregated(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, ExDaytona.Model.ModelsAggregatedUsage.t()} | {:error, Tesla.Env.t()}

Get aggregated usage Returns organization-level resource usage totals for a given time period

Parameters

connection (ExDaytona.Connection): Connection to server
organization_id (String.t): Organization ID
from (String.t): Start time (RFC3339)
to (String.t): End time (RFC3339)
opts (keyword): Optional parameters

Returns

{:ok, ExDaytona.Model.ModelsAggregatedUsage.t} on success
{:error, Tesla.Env.t} on failure

get_organization_usage_chart(connection, organization_id, from, to, opts \\ [])

@spec get_organization_usage_chart(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, [ExDaytona.Model.ModelsUsageChartPoint.t()]} | {:error, Tesla.Env.t()}

Get usage chart data Returns resource usage data points for a given time period with auto-scaled resolution

Parameters

connection (ExDaytona.Connection): Connection to server
organization_id (String.t): Organization ID
from (String.t): Start time (RFC3339)
to (String.t): End time (RFC3339)
opts (keyword): Optional parameters
- :region (String.t): Region filter

Returns

{:ok, [%ModelsUsageChartPoint{}, ...]} on success
{:error, Tesla.Env.t} on failure

get_organization_usage_per_sandbox(connection, organization_id, from, to, opts \\ [])

@spec get_organization_usage_per_sandbox(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, [ExDaytona.Model.ModelsSandboxUsage.t()]} | {:error, Tesla.Env.t()}

Get per-sandbox usage Returns resource usage aggregated per sandbox for a given time period

Parameters

connection (ExDaytona.Connection): Connection to server
organization_id (String.t): Organization ID
from (String.t): Start time (RFC3339)
to (String.t): End time (RFC3339)
opts (keyword): Optional parameters

Returns

{:ok, [%ModelsSandboxUsage{}, ...]} on success
{:error, Tesla.Env.t} on failure