rds.instances.events

The activity stream of a database: the newest events, oldest first

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

Request syntax

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

Path parameters

  • idRequired

    string

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

Query parameters

  • sinceOptional

    string

    Only events after this ISO time, for polling; omitted: from the first event

  • limitOptional

    number

    At most this many events (default 200)

    Constraints: integer, 1-500

Response

200 with the newest `limit` events (the first `limit` after `since` when given), oldest first: id, orgId, resourceType, resourceId, source, level, phase, message, createdAt.

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

Fields of data

  • [].​idAlways

    string

    Event id
  • [].​orgIdAlways

    string

    Organization the event belongs to
  • [].​resourceTypeAlways

    string

    Kind of resource; db_instance here
  • [].​resourceIdAlways

    string

    The database id
  • [].​sourceAlways

    one of control_plane, machine

    control_plane: a step the platform ran; machine: reported by a node
  • [].​levelAlways

    one of info, warn, error

    Severity
  • [].​phaseAlways

    string, may be null

    Stage it belongs to, e.g. provision, backup, upgrade
  • [].​messageAlways

    string

    What happened
  • [].​createdAtAlways

    string

    When it happened

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 events 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_events.