compute
GET /v1/compute/servers/{serverId}/overage
What this machine owes for bandwidth over its allowance this month.
Xác thực
Gửi khóa API dưới dạng mã thông báo bearer. Khóa này phải có quyền sites.view; khóa không có quyền này sẽ bị từ chối với mã lỗi 403, không phải 404.
Endpoint này không nhận ID tổ chức. Khóa của bạn đã xác định tổ chức mà nó thuộc về và phản hồi được giới hạn trong phạm vi đó.
Dùng thử
Thay thế bất kỳ nội dung nào trong ngoعل (angle brackets) bằng giá trị của riêng bạn và trình giữ chỗ key bằng một key từ trang tổng quan của bạn.
curl -X GET https://api.zinndigital.com/v1/compute/servers/{serverId}/overage \
-H "Authorization: Bearer zdk_live_…"Đã đăng nhập? Bảng điều khiển API trong trang quản lý của bạn sẽ tự điền ID tổ chức thực tế và khóa của riêng bạn, sau đó chạy yêu cầu đối với API trực tiếp để bạn có thể xem phản hồi thực tế. Mở điểm cuối này trong bảng điều khiển API
Chi tiết
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%.
Tham số
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
serverId (path) | Uuid | Có | 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. |
Phản hồi
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
period | string | Có | 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 | Có | 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 | Có | What that traffic costs the customer, in minor units of currency. |
settled_minor | integer | Có | How much of it has actually been captured. The gap up to accrued_minor is what the next threshold charges for. |
currency | string | Có | ISO 4217, or "" when nothing has been metered this period. |
next_threshold_minor | integer | Có | 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 | Có | The accrued total at which this machine is stopped regardless of payment, or null before the period has been priced. |
last_known_at | string | Có | 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[] | Có | Every threshold already raised this period, ascending. |
Các lỗi điểm cuối này có thể trả về
401 · 403 · 404 · 429