deploy.host-database.set-limit

Set the database size limit (MiB); over it the database is read only

PATCH /deploy/api/apps/{id}/host-databaseIAM deploy:ManageHostDatabaseChanges state

1 GiB unless set, 64 MiB to 20 GiB. Over the limit the pool host makes the database read only (writes fail with "cannot execute … in a read-only transaction") and get says so in limitProblem; below 90 % of the limit it is writable again.

Request syntax

PATCH /deploy/api/apps/{id}/host-database
{
  "limitMb": "number"
}

Path parameters

  • idRequired

    string

    Constraints: uuid

Request body

  • limitMbRequired

    number

    The size limit in MiB, 64 (64 MiB) to 20480 (20 GiB); over it the database is read only

    Constraints: integer, 64-20480

Response

200 with `data`: `limitMb`, the limit now set; the pool host applies it at its next pull. 400 for a limit outside 64–20480 or an app not on pooled hosting, 404 when the app is not the caller’s or has no active pool-host database, 409 while the app is being deleted.

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

Fields of data

  • limitMbAlways

    number

    The size limit now set, in MiB

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:ManageHostDatabase 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 set-limit id --limit-mb 1

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_set-limit.