rds.instances.describe-maintenance

Versions per node, the pending minor upgrade, the maintenance window and when it next opens

GET /rds/api/instances/{id}/maintenanceIAM rds:DescribeDBInstancesRead

Request syntax

GET /rds/api/instances/{id}/maintenance

Path parameters

  • idRequired

    string

    Constraints: 3-64 chars, /^(?!ewdoc-)[a-z0-9-]+$/

Response

200 with engineVersion, upgradeTarget, upgradeableTo (minors), majorUpgradeableTo, maintenanceWindow, autoMinorVersionUpgrade, nextWindowStart, inPlaceUpgrades, inProgress and nodes: each node’s id, name, engineVersion, whether its maintenance agent answers, and its lastOperation.

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

Fields of data

  • engineVersionAlways

    string

    PostgreSQL version of the database, e.g. 17.11
  • upgradeTargetAlways

    string, may be null

    Minor the next maintenance window installs; null: none pending
  • upgradeableToAlways

    array of string

    Newer minors of its major that upgrade can install
  • majorUpgradeableToAlways

    array of string

    Newer majors it can move to, each at its pinned minor
  • maintenanceWindowAlways

    string, may be null

    Maintenance window, UTC ddd:hh24:mi-ddd:hh24:mi
  • autoMinorVersionUpgradeAlways

    boolean

    Whether new minors are applied in the window
  • nextWindowStartAlways

    string, may be null

    When the window next opens; null: no window
  • inPlaceUpgradesAlways

    boolean

    Every node can be upgraded in place
  • inProgressAlways

    boolean

    Maintenance is running now
  • nodesAlways

    array of object

    Each node with a machine
  • nodes[].​idAlways

    string

    Node id
  • nodes[].​nameAlways

    string

    Node name
  • nodes[].​engineVersionAlways

    string, may be null

    Version the node runs; null until it reports
  • nodes[].​agentAlways

    boolean

    Whether the node takes in-place maintenance work
  • nodes[].​lastOperationAlways

    object, may be null

    Current or last maintenance operation; null: none
  • nodes[].​lastOperation.​statusAlways

    one of pending, running, succeeded, failed

    State of the operation
  • nodes[].​lastOperation.​packageVersionAlways

    string

    Package version it installs
  • nodes[].​lastOperation.​requestedAtAlways

    string

    When it was asked for
  • nodes[].​lastOperation.​finishedAtAlways

    string, may be null

    When it finished

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 rds:DescribeDBInstances 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 rds instances describe-maintenance id

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