身份验证
请将 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 ru… |
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 w… |
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 d… |
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 b… |
此端点可能返回的错误
401 · 403 · 404