compute

GET /v1/compute/servers/{serverId}/overage

What this machine owes for bandwidth over its allowance this month.

Svi compute krajnji točke

Autentifikacija

Pošaljite API ključ kao nosivi token. Ključ mora imati dozvolu sites.view; ključ bez nje se odbija s kodom 403, a ne 404.

Ova krajnja točka ne prihvaća ID organizacije. Vaš ključ već identificira organizaciju kojoj pripada, a odgovor je ograničen na nju.

Isprobajte

Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.

curl -X GET https://api.zinndigital.com/v1/compute/servers/{serverId}/overage \
  -H "Authorization: Bearer zdk_live_…"

Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli

Pojedinosti

The traffic this machine has carried beyond its included allowance in the current metering period, what it has cost, what has already been paid, and the next threshold at which a charge is raised. Requires `sites.view`. Overage is charged **automatically at each threshold** rather than as one bill at the end of the month, so this is the screen that answers "why was my card charged". `charges` lists every threshold already raised for the period with what happened to it, including a decline — a decline is why a machine gets stopped, so it must be visible here rather than only in an email. `period` is the **provider's** metering month (`YYYY-MM`, UTC), not the subscription's billing period. The provider resets the counter it meters on at their month boundary, and the two disagree for anyone who bought mid-month; keying on the subscription's period would double-charge or free-ride on the first of every month. `last_known_at` is when a reading was last actually obtained. `null` beside a zero accrual means we have never had a number for this machine this period — **not** that it owes nothing — and a client must render that difference for the same reason it must not render an unknown usage gauge as `0%`.

Parametri

NazivVrstaObaveznoŠto je to
serverId (path)UuidDaThe server's id, as `listComputeServers` reports it. **Ours** (UUIDv7), minted when the order row was written — never the provider's own identifier for the machine.

Odgovor

NazivVrstaObaveznoŠto je to
periodstringDaThe **provider's** metering month, `YYYY-MM` in UTC — not the subscription's billing period. The provider resets the counter at their month boundary and the two disagree for any…
overage_gbnumberDaThe highest overage reading seen this period, in gigabytes. A high-water mark, not a sum: the provider states the month to date, so adding successive readings would count the sa…
accrued_minorintegerDaWhat that traffic costs the customer, in minor units of `currency`.
settled_minorintegerDaHow much of it has actually been **captured**. The gap up to `accrued_minor` is what the next threshold charges for.
currencystringDaISO 4217, or `""` when nothing has been metered this period.
next_threshold_minorintegerDaThe next accrued total at which a charge is raised, or `null` when the ladder's rungs are all settled or none is configured.
hard_ceiling_minorintegerDaThe accrued total at which this machine is stopped regardless of payment, or `null` before the period has been priced.
last_known_atstringDaWhen a reading was last actually obtained. ⛔ `null` beside a zero accrual means we have never had a number this period — **not** that the machine owes nothing. The same distinct…
chargesOverageChargeAttempt[]DaEvery threshold already raised this period, ascending.

Pogreške koje ova krajnja točka može vratiti

401 · 403 · 404 · 429