rds.backups.list-restore-jobsList restore jobs for a database instance
Request syntax
GET /rds/api/instances/{id}/restore-jobsPath parameters
idRequiredstring
Constraints: 3-64 chars, /^(?!ewdoc-)[a-z0-9-]+$/
Response
200 with up to 50 restore jobs whose source is this database, newest first: id, orgId, sourceDbInstanceId, targetDbInstanceId, recoveryTarget, recoveryTargetTime, recoveryTargetLabel, baseBackupLabel, status, error, requestedByIamUserId, startedAt, finishedAt, createdAt.
A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.
Fields of data
[].idAlwaysstring
Restore job id[].orgIdAlwaysstring
Organization that owns the databases[].sourceDbInstanceIdAlwaysstring
Database whose backups are restored[].targetDbInstanceIdAlwaysstring, may be null
New database the restore builds; null once that database is deleted[].recoveryTargetAlwaysone of latest, time, label
latest, a point in time, or a labelled backup[].recoveryTargetTimeAlwaysstring, may be null
The point in time, for time[].recoveryTargetLabelAlwaysstring, may be null
The backup label, for label[].baseBackupLabelAlwaysstring, may be null
Backup the restore starts from; set when it starts[].statusAlwaysone of queued, restoring, completed, cancelled, failed
cancelled: withdrawn before it started[].errorAlwaysstring, may be null
Why it failed or who cancelled it; null otherwise[].requestedByIamUserIdAlwaysstring, may be null
IAM user who asked; null once that user is deleted[].startedAtAlwaysstring, may be null
When the restore started[].finishedAtAlwaysstring, may be null
When it finished or was cancelled[].createdAtAlwaysstring
When it was requested
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:ListBackups 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 backups list-restore-jobs idcurl -X GET "https://console.platform-development.deutschecloud.app/rds/api/instances/id/restore-jobs" \
-H "Authorization: EWS-ACCESS-KEY $ACCESS_KEY"Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_rds_backups_list-restore-jobs.