rds.branches.set-poolHow old the pool base may be before a new branch refreshes it
Request syntax
PATCH /rds/api/instances/{id}/branch-pool
{
"staleAfterHours": "number"
}Path parameters
idRequiredstring
Constraints: 3-64 chars, /^(?!ewdoc-)[a-z0-9-]+$/
Request body
staleAfterHoursRequirednumber
A branch asked for on an older base refreshes it first; 0: always
Constraints: integer, 0-720
Response
200 with the branch pool, as `list` shows it, with its new staleAfterHours.
A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.
Fields of data
idAlwaysstring
Branch pool idstatusAlwaysone of building, preparing, available, refreshing, deleting, failed
State of the poolhostAlwaysobject, may be null
The machine the branches run on; null before it existshost.dbInstanceIdAlwaysstring
Database id of the pool machinehost.identifierAlwaysstring
Its namehost.instanceClassAlwaysstring
Its instance typehost.allocatedStorageGibAlwaysnumber
Its storage, GiBhost.statusAlwaysstring
Its statebaseRestoredAtAlwaysstring, may be null
The moment the base's data is frommaskedAtAlwaysstring, may be null
When the base was maskedmaskRulesCurrentAlwaysboolean
False when the masking rules changed since: the next branch refreshes the basestaleAfterHoursAlwaysnumber
A branch asked for on an older base refreshes it first; 0: alwaysrefreshDueAlwaysstring, may be null
Why the next branch will refresh the base first; null when it will notoperationAlwaysobject, may be null
The pool's operation in progress; null: noneoperation.idAlwaysstring
Operation idoperation.kindAlwaysone of prepare-base, refresh-base
What is being doneoperation.statusAlwaysone of pending, running
Waiting or runningoperation.requestedAtAlwaysstring
When it was asked foroperation.claimedAtWhen presentstring
When the pool machine took it upoperation.attemptsAlwaysnumber
Tries so faroperation.rulesHashWhen presentstring, may be null
Fingerprint of the masking rules the base is masked withusageAlwaysobject, may be null
Space, as the pool machine last reported; null: not reportedusage.poolSizeBytesAlwaysnumber
Size of the pool storage, bytesusage.poolFreeBytesAlwaysnumber
Free, bytesusage.baseUsedBytesAlwaysnumber
Taken by the base, bytesusage.branchesAlwaysarray of object
Each branchusage.branches[].idAlwaysstring
Branch idusage.branches[].usedBytesAlwaysnumber
Bytes written since the cloneusage.branches[].runningAlwaysboolean
Whether its server runsusageReportedAtAlwaysstring, may be null
When usage was reportedlastErrorAlwaysstring, may be null
Why the pool last failed; null otherwiseemptySinceAlwaysstring, may be null
Since when the pool holds no branch; null while it holds some
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 set-pool id --stale-after-hours 1curl -X PATCH "https://console.platform-development.deutschecloud.app/rds/api/instances/id/branch-pool" \
-H "Authorization: EWS-ACCESS-KEY $ACCESS_KEY" \
-H "Content-Type: application/json" \
-d '{"staleAfterHours":1}'Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_rds_branches_set-pool.