rds.branches.refresh-pool

Restore the latest backup into a new pool base and mask it; existing branches keep theirs

POST /rds/api/instances/{id}/branch-pool/refreshIAM rds:ModifyDBBranchSettingsChanges state

Request syntax

POST /rds/api/instances/{id}/branch-pool/refresh

Path parameters

  • idRequired

    string

    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

  • poolAlways

    object

    The pool, now preparing or refreshing
  • pool.​idAlways

    string

    Branch pool id
  • pool.​statusAlways

    one of building, preparing, available, refreshing, deleting, failed

    State of the pool
  • pool.​hostAlways

    object, may be null

    The machine the branches run on; null before it exists
  • pool.​host.​dbInstanceIdAlways

    string

    Database id of the pool machine
  • pool.​host.​identifierAlways

    string

    Its name
  • pool.​host.​instanceClassAlways

    string

    Its instance type
  • pool.​host.​allocatedStorageGibAlways

    number

    Its storage, GiB
  • pool.​host.​statusAlways

    string

    Its state
  • pool.​baseRestoredAtAlways

    string, may be null

    The moment the base's data is from
  • pool.​maskedAtAlways

    string, may be null

    When the base was masked
  • pool.​maskRulesCurrentAlways

    boolean

    False when the masking rules changed since: the next branch refreshes the base
  • pool.​staleAfterHoursAlways

    number

    A branch asked for on an older base refreshes it first; 0: always
  • pool.​refreshDueAlways

    string, may be null

    Why the next branch will refresh the base first; null when it will not
  • pool.​operationAlways

    object, may be null

    The pool's operation in progress; null: none
  • pool.​operation.​idAlways

    string

    Operation id
  • pool.​operation.​kindAlways

    one of prepare-base, refresh-base

    What is being done
  • pool.​operation.​statusAlways

    one of pending, running

    Waiting or running
  • pool.​operation.​requestedAtAlways

    string

    When it was asked for
  • pool.​operation.​claimedAtWhen present

    string

    When the pool machine took it up
  • pool.​operation.​attemptsAlways

    number

    Tries so far
  • pool.​operation.​rulesHashWhen present

    string, may be null

    Fingerprint of the masking rules the base is masked with
  • pool.​usageAlways

    object, may be null

    Space, as the pool machine last reported; null: not reported
  • pool.​usage.​poolSizeBytesAlways

    number

    Size of the pool storage, bytes
  • pool.​usage.​poolFreeBytesAlways

    number

    Free, bytes
  • pool.​usage.​baseUsedBytesAlways

    number

    Taken by the base, bytes
  • pool.​usage.​branchesAlways

    array of object

    Each branch
  • pool.​usage.​branches[].​idAlways

    string

    Branch id
  • pool.​usage.​branches[].​usedBytesAlways

    number

    Bytes written since the clone
  • pool.​usage.​branches[].​runningAlways

    boolean

    Whether its server runs
  • pool.​usageReportedAtAlways

    string, may be null

    When usage was reported
  • pool.​lastErrorAlways

    string, may be null

    Why the pool last failed; null otherwise
  • pool.​emptySinceAlways

    string, may be null

    Since when the pool holds no branch; null while it holds some
  • branchesAlways

    number

    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 id

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.