rds.instances.describe-parametersEvery settable PostgreSQL parameter: its machine-sized default, your value, what runs now
Request syntax
GET /rds/api/instances/{id}/parametersPath parameters
idRequiredstring
Constraints: 3-64 chars, /^(?!ewdoc-)[a-z0-9-]+$/
Response
200 with memoryGib, runningError (why running values could not be read, else null) and parameters: name, category, description, kind, restart, default, value, running, pendingRestart.
A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.
Fields of data
memoryGibAlwaysnumber, may be null
Memory of the instance type the defaults are sized from, GiB; null: unknown typerunningErrorAlwaysstring, may be null
Why the running values could not be read; null when they wereparametersAlwaysarray of object
Every settable parameterparameters[].nameAlwaysstring
Parameter name, e.g. work_memparameters[].categoryAlwaysone of Memory, Connections, Query tuning, Timeouts, Logging, Autovacuum, WAL
Group it is shown inparameters[].descriptionAlwaysstring
What it doesparameters[].kindAlwaysone of memory, duration, integer, real, bool, enum
Kind of value it takesparameters[].restartAlwaysboolean
A change takes effect at the next restartparameters[].defaultAlwaysstring, may be null
Default sized from the machine; null: unknown typeparameters[].valueAlwaysstring, may be null
Your value; null: the defaultparameters[].runningAlwaysstring, may be null
Value the server runs now; null when it could not be readparameters[].pendingRestartAlwaysboolean
The server waits for a restart to apply a change
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:DescribeDBParameters 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 instances describe-parameters idcurl -X GET "https://console.platform-development.deutschecloud.app/rds/api/instances/id/parameters" \
-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_instances_describe-parameters.