databases
GET /v1/databases/{databaseId}
One managed database.
Аутентификација
Пошаљите API кључ као bearer токен. Ова крајња тачка не наводи конкретну дозволу у спецификацији, па свом кључу доделите најмања неопходна овлашћења и проверите одговор уместо да претпостављате.
Ова крајња тачка не прихвата id организације. Ваш кључ већ идентификује организацију којој припада, а одговор је ограничен на њу.
Испробајте
Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.
curl -X GET https://api.zinndigital.com/v1/databases/{databaseId} \
-H "Authorization: Bearer zdk_live_…"Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом API-ју како бисте могли да видите стварни одговор. Отворите ову крајњу тачку у API конзоли
Детаљи
Everything needed to understand and operate the database — host, port, database name, username, size, backup history and whether a restore has ever been proved. Gated on databases.view. ⛔ Never includes the password.
Параметри
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
databaseId (path) | string | Да | — |
Одговор
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
id | string | Да | — |
label | string | Да | The customer's own name for it. Never sent to the infrastructure. |
engine | string<postgres, mysql> | Да | Which engine this database runs (docs/497). Modelled as a field from the start, which is why MySQL was additive rather than a migration of every row. |
engine_version | string | Да | The engine's major — "18", "8.4". The patch level is ours to keep current and is deliberately not customer-selectable: choosing your own patch level means choosing to run… |
engine_label | string | Не | The engine and version as a customer sees them — "PostgreSQL 18", "MySQL 8.4". Assembled by the API so three frontends cannot disagree about a product name. |
size | string | Да | A code from GET /v1/databases/catalogue. |
status | string<provisioning, available, failed, suspended, deleting, deleted> | Да | — |
status_detail | string | Не | Why a failed instance failed. Empty otherwise. |
host | string | Не | Empty until the instance is available. |
port | integer | Да | — |
database_name | string | Да | — |
username | string | Да | — |
high_availability | boolean | Да | Whether a standby replica is held with automatic failover. The property customers actually choose on — stated rather than inferred from the size, because an inference goes… |
vcpu | integer | Не | — |
ram_gb | integer | Не | — |
storage_gb | integer | Не | — |
tls_required | boolean | Да | Always true. TLS is a precondition of selling a publicly reachable database, not a feature that can be turned off. |
created_at | string | Да | — |
last_backup_at | string | Не | When a backup last completed. null means none has ever run. |
order_line_id | object | Не | The paid basket line this database fulfils, or null for one that predates the purchase path or that staff tooling created. The subscription that bills it carries the same id. |
billing | ManagedDatabaseBilling | Не | The subscription paying for this database — what it costs, and when it next renews. ⛔ null means no subscription pays for it, which is a real state (a row created before… |
restore_verified_at | string | Не | When a backup of this database was last proved restorable by restoring it and reading a row back over a client connection. ⛔ Deliberately separate from last_backup_at: a… |
Грешке које ова крајња тачка може вратити
401 · 403 · 404