deploy.host-database.get

Show a pooled app's pool-host database and its backups, newest first

GET /deploy/api/apps/{id}/host-databaseIAM deploy:DescribeAppRead

Request syntax

GET /deploy/api/apps/{id}/host-database

Path parameters

  • idRequired

    string

    Constraints: uuid

Response

200 with `data`: `database` (name, state, hostState, bytes, lastBackupAt, lastRestoreAt, backupPending, restorePending, lastError, limitMb, overLimit, limitProblem, createdAt; null when the app has none) and `backups` (each finished one: id, reason, bytes, createdAt, completedAt, expiresAt; newest first, at most 50). 400 for an app not on pooled hosting, 404 when the app is not the caller’s.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Fields of data

  • databaseAlways

    object, may be null

    The app’s pool-host database; null if it has none
  • database.​nameAlways

    string

    Name of the database and its role on the host (app_ and 12 hex)
  • database.​stateAlways

    one of active, dropping, dropped

    active; dropping once moved or deleted, until the host has dropped it
  • database.​hostStateAlways

    one of provisioning, ready, draining, lost, may be null

    State of the pool host it lives on; null until the app is placed
  • database.​bytesAlways

    number, may be null

    Size as last reported, in bytes; null if not yet
  • database.​lastBackupAtAlways

    string, may be null

    When it was last backed up; null if never
  • database.​lastRestoreAtAlways

    string, may be null

    When a backup was last restored; null if never
  • database.​backupPendingAlways

    boolean

    Whether a backup was asked for and not yet taken
  • database.​restorePendingAlways

    boolean

    Whether a restore was asked for and not yet done
  • database.​lastErrorAlways

    string, may be null

    The host’s last error with it; null if none
  • database.​limitMbAlways

    number

    Its size limit in MiB; over it the database is read only
  • database.​overLimitAlways

    boolean

    Whether the pool host found it over its limit and made it read only
  • database.​limitProblemAlways

    string, may be null

    While it is over its limit: what happened and what to do; otherwise null
  • database.​createdAtAlways

    string

    When it was added
  • backupsAlways

    array of object

    Its finished backups, newest first (at most 50)
  • backups[].​idAlways

    string

    Backup id, for restore
  • backups[].​reasonAlways

    one of daily, manual, before-delete, before-restore, move

    Why it was taken
  • backups[].​bytesAlways

    number, may be null

    Size of the dump, in bytes
  • backups[].​createdAtAlways

    string

    When it was asked for
  • backups[].​completedAtAlways

    string, may be null

    When it was finished
  • backups[].​expiresAtAlways

    string

    When it is deleted

Checked against the handlers: every route test validates their answers against this schema.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow deploy:DescribeApp on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud deploy host-database get id

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_deploy_host-database_get.