rds.branches.refresh-poolRestore the latest backup into a new pool base and mask it; existing branches keep theirs
Request syntax
POST /rds/api/instances/{id}/branch-pool/refreshPath parameters
idRequiredstring
Constraints: 3-64 chars, /^(?!ewdoc-)[a-z0-9-]+$/
Response
202 with { pool, branches }: the pool (status preparing or refreshing) and how many branches it holds.
A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.
Fields of data
poolAlwaysobject
The pool, now preparing or refreshingpool.idAlwaysstring
Branch pool idpool.statusAlwaysone of building, preparing, available, refreshing, deleting, failed
State of the poolpool.hostAlwaysobject, may be null
The machine the branches run on; null before it existspool.host.dbInstanceIdAlwaysstring
Database id of the pool machinepool.host.identifierAlwaysstring
Its namepool.host.instanceClassAlwaysstring
Its instance typepool.host.allocatedStorageGibAlwaysnumber
Its storage, GiBpool.host.statusAlwaysstring
Its statepool.baseRestoredAtAlwaysstring, may be null
The moment the base's data is frompool.maskedAtAlwaysstring, may be null
When the base was maskedpool.maskRulesCurrentAlwaysboolean
False when the masking rules changed since: the next branch refreshes the basepool.staleAfterHoursAlwaysnumber
A branch asked for on an older base refreshes it first; 0: alwayspool.refreshDueAlwaysstring, may be null
Why the next branch will refresh the base first; null when it will notpool.operationAlwaysobject, may be null
The pool's operation in progress; null: nonepool.operation.idAlwaysstring
Operation idpool.operation.kindAlwaysone of prepare-base, refresh-base
What is being donepool.operation.statusAlwaysone of pending, running
Waiting or runningpool.operation.requestedAtAlwaysstring
When it was asked forpool.operation.claimedAtWhen presentstring
When the pool machine took it uppool.operation.attemptsAlwaysnumber
Tries so farpool.operation.rulesHashWhen presentstring, may be null
Fingerprint of the masking rules the base is masked withpool.usageAlwaysobject, may be null
Space, as the pool machine last reported; null: not reportedpool.usage.poolSizeBytesAlwaysnumber
Size of the pool storage, bytespool.usage.poolFreeBytesAlwaysnumber
Free, bytespool.usage.baseUsedBytesAlwaysnumber
Taken by the base, bytespool.usage.branchesAlwaysarray of object
Each branchpool.usage.branches[].idAlwaysstring
Branch idpool.usage.branches[].usedBytesAlwaysnumber
Bytes written since the clonepool.usage.branches[].runningAlwaysboolean
Whether its server runspool.usageReportedAtAlwaysstring, may be null
When usage was reportedpool.lastErrorAlwaysstring, may be null
Why the pool last failed; null otherwisepool.emptySinceAlwaysstring, may be null
Since when the pool holds no branch; null while it holds somebranchesAlwaysnumber
Branches the pool holds
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:ModifyDBBranchSettings 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 branches refresh-pool idcurl -X POST "https://console.platform-development.deutschecloud.app/rds/api/instances/id/branch-pool/refresh" \
-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_branches_refresh-pool.