rds.extensions.enable

CREATE EXTENSION in a database; 202 when its library must be preloaded and the database restarted first

POST /rds/api/instances/{id}/extensions/{extension}/enableIAM rds:EnableDBExtensionChanges state

Request syntax

POST /rds/api/instances/{id}/extensions/{extension}/enable
{
  "database": "string"
}

Path parameters

  • idRequired

    string

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

  • extensionRequired

    string

    Constraints: 1-63 chars, /^[a-z0-9_-]+$/

Request body

  • databaseOptional

    string

    Database to create the extension in; omitted: the one created with the instance

    Constraints: 1-63 chars

Response

200 with { state: "enabled", version, created, message } (created lists the extensions installed); 202 with state "restart-required" (version null, created empty) when the database must be rebooted before the extension can be enabled.

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

Fields of data

  • stateAlways

    one of enabled, restart-required

    enabled, or restart-required: reboot, then enable again
  • versionAlways

    string, may be null

    Version now enabled; null when a restart is required
  • createdAlways

    array of string

    Extensions installed by this call, dependencies included
  • messageAlways

    string

    What happened, in a sentence

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:EnableDBExtension 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 extensions enable id extension

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