rds.replication.get

The replication mode and whether it holds right now: ok, degraded (no standby acknowledging), async

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

Request syntax

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

Path parameters

  • idRequired

    string

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

Response

200 with { mode, state, syncStandbys }: state is ok, degraded, async or unknown (the cluster did not answer); syncStandbys names the members a commit waits for.

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

Fields of data

  • modeAlways

    one of async, sync

    The mode asked for
  • stateAlways

    one of ok, degraded, async, unknown

    ok: sync and a standby acknowledges commits; degraded: sync but none does; async; unknown: the cluster did not answer
  • syncStandbysAlways

    array of string

    Members a commit waits for (any one of them)

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 replication get id

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