compute
GET /v1/compute/servers/{serverId}/overage
What this machine owes for bandwidth over its allowance this month.
Πισtoποίηση
Στείλτε ένα κλειδί API ως διακριτικό φορέα (bearer token). Το κλειδί πρέπει να διαθέτει το δικαίωμα sites.view· ένα κλειδί που δεν το διαθέτει απορρίπτεται με 403, όχι 404.
Αυτό το τελικό σημείο δεν δέχεται αναγνωριστικό οργανισμού. Το κλειδί σας προσδιορίζει ήδη τον οργανισμό στον οποίο ανήκει, και η απάντηση περιορίζεται σε αυτόν.
Δοκιμάστε το
Ατικatastήstε ό,τι βρίskεtai μέσα σe γώniaδeς μe τis δikές sas timές, kai to placeholder klεidioύ μe éna klεidi apó ton pinaka ελέgchou sas.
curl -X GET https://api.zinndigital.com/v1/compute/servers/{serverId}/overage \
-H "Authorization: Bearer zdk_live_…"Συνδεθήκατε; Η κονσόλα API στον πίνακα ελέγχου σας συμπληρώνει το πραγματικό αναγνωριστικό του οργανισμού σας και το δικό σας κλειδί, και εκτελεί το αίτημα στο ζωντανό API, ώστε να μπορείτε να δείτε την πραγματική απόκριση. Ανοίξτε αυτό το τελικό σημείο στην κονσόλα API
Λεπτομέρειες
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%.
Παράμετροι
| Όνομα | Τύpος | Υποχρεωτικό | Τι είναι |
|---|---|---|---|
serverId (path) | Uuid | Ναι | The 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. |
Απάντηση
| Όνομα | Τύpος | Υποχρεωτικό | Τι είναι |
|---|---|---|---|
period | string | Ναι | The 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… |
overage_gb | number | Ναι | The 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 same… |
accrued_minor | integer | Ναι | What that traffic costs the customer, in minor units of currency. |
settled_minor | integer | Ναι | How much of it has actually been captured. The gap up to accrued_minor is what the next threshold charges for. |
currency | string | Ναι | ISO 4217, or "" when nothing has been metered this period. |
next_threshold_minor | integer | Ναι | The 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_minor | integer | Ναι | The accrued total at which this machine is stopped regardless of payment, or null before the period has been priced. |
last_known_at | string | Ναι | When 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… |
charges | OverageChargeAttempt[] | Ναι | Every threshold already raised this period, ascending. |
Σφάλματα που μπορεί να επιστρέψει αυτό το τελικό σημείο
401 · 403 · 404 · 429