compute
GET /v1/compute/servers/{serverId}/overage
What this machine owes for bandwidth over its allowance this month.
ავტორიზაცია
API გასაღები გაგზავნეთ როგორც მატარებელი ტოკენი (bearer token). გასაღებს უნდა ჰქონდეს sites.view ნებართვა; ამის გარეშე გასაღები უარყოფილი იქნება 403 და არა 404 სტატუსით.
ეს ბოლო წერტილი არ იღებს ორგანიზაციის იდენტიფიკატორს. თქვენი გასაღები უკვე აიდენტიფიცირებს იმ ორგანიზაციას, რომელსაც ის ეკუთვნის, და პასუხი შემოფარგლულია მისით.
სცადეთ
შეSubstituted any value inside angle brackets with your own and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/compute/servers/{serverId}/overage \
-H "Authorization: Bearer zdk_live_…"შესული ხართ? თქვენი სამართავ პანელში არსებული API კონსოლი ავტომატურად ამატებს თქვენი რეალური ორგანიზაციის ID-სა და საკუთარ გასაღებს და ატარებს მოთხოვნას ცოცხალ API-ს წინააღმდეგ, რათა იხილოთ რეალური პასუხი. გაAღით ეს ენდპოინტი 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%`.
პარამეტრები
| სახელი | ტიპი | სავალდებულო | რა არის ეს |
|---|---|---|---|
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. |
პასუხი
| სახელი | ტიპი | სავალდებულო | რა არის ეს |
|---|---|---|---|
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 any… |
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 sa… |
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 distinct… |
charges | OverageChargeAttempt[] | დიახ | Every threshold already raised this period, ascending. |
შეცდომები, რომლებიც ამ ენდპოინტს შეუძლია დააბრუნოს
401 · 403 · 404 · 429