rds.branches.get-settings

Masking rules and pull-request branches of a database

GET /rds/api/instances/{id}/branch-settingsIAM rds:DescribeDBBranchesRead

Request syntax

GET /rds/api/instances/{id}/branch-settings

Path parameters

  • idRequired

    string

    Constraints: 3-64 chars, /^(?!ewdoc-)[a-z0-9-]+$/

Response

200 with { masking, pullRequests }, in the shape set-settings takes.

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

Fields of data

  • maskingAlways

    array of object

    Columns rewritten in the pool base before any branch sees it
  • masking[].​databaseAlways

    string

    Database inside the instance
  • masking[].​schemaAlways

    string

    Schema of the table
  • masking[].​tableAlways

    string

    Table
  • masking[].​columnAlways

    string

    Column rewritten
  • masking[].​methodAlways

    one of null, redact, hash, email, phone, name

    How the column is rewritten
  • pullRequestsAlways

    object, may be null

    A branch per pull request; null: off
  • pullRequests.​gitRepositoryIdAlways

    string

    Git repository whose pull requests get a branch
  • pullRequests.​targetBranchesAlways

    array of string

    Pull requests into these branches; empty: the repository's default branch

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-settings 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_get-settings.