compute
GET /v1/compute/servers/{serverId}/usage
One server's metered hours, charges and ledger check for a month.
Аутентификация
Передайте API-ключ в качестве маркера носителя (bearer token). Эта конечная точка не указывает конкретное разрешение в спецификации, поэтому предоставьте своему ключу минимум необходимых прав и проверьте ответ, вместо того чтобы делать предположения.
Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
curl -X GET https://api.zinndigital.com/v1/compute/servers/{serverId}/usage \
-H "Authorization: Bearer zdk_live_…"Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли
Параметры
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
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 (query) | string | Нет | The month, YYYY-MM (UTC). Defaults to the current month. |
Ответ
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
period | string | Да | — |
hours | integer | Да | Started hours rated in the month. |
rated_minor | integer | Да | Whole minor units rated. A sub-unit remainder is carried, never rounded up. |
settled_minor | integer | Да | Net of tax |
unsettled_minor | integer | Да | Rated and not yet paid. |
currency | string | Да | — |
settlements | ComputeUsageSettlement[] | Да | — |
reconciles | boolean | Да | Whether hours, settlements, their orders and the balance draws all agree. It is computed from four independently written records, never a figure against itself. |
discrepancies | string[] | Да | Every disagreement found, in words. Empty when reconciles is true. |
Ошибки, которые может возвращать этот эндпоинт
401 · 403 · 404 · 422 · 429