rds.extensions.disable

DROP EXTENSION; 409 listing dependent objects unless cascade is true

POST /rds/api/instances/{id}/extensions/{extension}/disableIAM rds:DisableDBExtensionChanges stateDestructive

Request syntax

POST /rds/api/instances/{id}/extensions/{extension}/disable
{
  "database": "string",
  "cascade": "boolean"
}

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 drop the extension from; omitted: the one created with the instance

    Constraints: 1-63 chars

  • cascadeOptional

    boolean

    Drop the objects that depend on the extension too; off by default, and a drop with dependents is then refused with 409 listing them

    Default: false

Response

200 with { state: "disabled", cascaded, message }; cascaded lists the objects dropped with it.

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

Fields of data

  • stateAlways

    "disabled"

    The extension was dropped
  • cascadedAlways

    array of string

    Objects dropped with it (cascade only)
  • 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:DisableDBExtension 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 disable 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_disable.