rds.branches.get

One branch: status, data as of, masking, connection, create time

GET /rds/api/branches/{branchId}IAM rds:DescribeDBBranchesRead

Request syntax

GET /rds/api/branches/{branchId}

Path parameters

  • branchIdRequired

    string

    Constraints: /^ewbr-[0-9a-f]{12}$/

Response

200 with the branch: id, parentDbInstanceId, name, status, origin, recoveryTargetTime, dataAsOf, masked, maskRuleCount, expiresAt, source, pullRequest, connection, usedBytes, error, requestedAt, availableAt, createTookMs, agentTookMs.

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

Fields of data

  • idAlways

    string

    Branch id (ewbr-…)
  • parentDbInstanceIdAlways

    string

    Database the branch is of
  • nameAlways

    string

    Branch name
  • statusAlways

    one of queued, creating, available, deleting, deleted, failed

    State of the branch
  • originAlways

    one of base, time

    base: a clone of the pool's base; time: restored to recoveryTargetTime
  • recoveryTargetTimeAlways

    string, may be null

    The moment asked for, for origin time
  • dataAsOfAlways

    string, may be null

    The moment the branch's data is from
  • maskedAlways

    boolean

    Whether masking rules were applied to its data
  • maskRuleCountAlways

    number

    Masking rules applied
  • expiresAtAlways

    string, may be null

    When the branch is deleted; null for a pull-request branch, which lives with its pull request
  • sourceAlways

    one of api, pull_request

    Asked for through the API or console, or made for a pull request
  • pullRequestAlways

    object, may be null

    The pull request it was made for; null otherwise
  • pullRequest.​gitRepositoryIdAlways

    string

    Git repository
  • pullRequest.​numberAlways

    number

    Pull request number
  • connectionAlways

    object

    Where to connect
  • connection.​hostAlways

    string, may be null

    Host to connect to; null until the branch pool has one
  • connection.​portAlways

    number, may be null

    Port of the branch; null until it is assigned
  • connection.​databaseAlways

    string

    Database to connect to
  • connection.​userAlways

    string

    The master user of the parent database
  • connection.​secretNameAlways

    string

    Secrets entry holding every login role's password on the branch
  • connection.​urlAlways

    string, may be null

    postgres:// URL without the password; null while host or port is unknown
  • usedBytesAlways

    number, may be null

    Bytes written to the branch since it was cut, as last reported
  • errorAlways

    string, may be null

    Why it failed; null otherwise
  • requestedAtAlways

    string

    When it was asked for
  • availableAtAlways

    string, may be null

    When it became available
  • createTookMsAlways

    number, may be null

    Request to available, milliseconds
  • agentTookMsAlways

    number, may be null

    Time the branch machine spent creating it, milliseconds

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:DescribeDBBranches 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 get branchId

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