compute
GET /v1/compute/servers/{serverId}/overage
What this machine owes for bandwidth over its allowance this month.
توثيقِ شناخت
ایک بیرر ٹوکن کے طور پر ایک API کی بھیجیں۔ کی کے پاس sites.view اجازت ہونی چاہیے؛ اس کے بغیر کی کو 404 کے بجائے 403 کے ساتھ مسترد کر دیا جاتا ہے۔
یہ اینڈ پوائنٹ کوئی آرگنائزیشن آئی ڈی نہیں لیتا۔ آپ کی کلید پہلے ہی اس آرگنائزیشن کی شناخت کرتی ہے جس سے یہ تعلق رکھتی ہے، اور اس کا جواب اسی کے مطابق محدود ہوتا ہے۔
آزمائیں
کوئی بھی چیز جو زاویہ دار قوسین میں ہو اسے اپنی اقدار سے بدلیں، اور کلیدی پلیس ہولڈر کو اپنے ڈیش بورڈ کی کسی کلید سے بدلیں۔
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%.
پیرامیٹرز
| نام | قسم | لازمی | یہ کیا ہے |
|---|---|---|---|
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… |
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