All Products
Search

This Product

    ApsaraDB RDS:CreatePostgresExtensions

    Document Center

    ApsaraDB RDS:CreatePostgresExtensions

    Last Updated:May 11, 2024

    Creates an extension for a database.

    Operation description

    Supported database engines

    RDS PostgreSQL

    References

    Note : Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.

    Manage extensions

    Precautions

    Install only the plug-ins that are supported by the major engine version of the instance. Otherwise, the installation fails.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    rds:CreatePostgresExtensions
    • acs:rds:{#regionId}:{#accountId}:*
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ClientTokenstringNo

    The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the generated token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

    		ETnLKlblzczshOTUbOCz****
    DBInstanceIdstringYes

    The instance ID. You can call the DescribeDBInstances operation to query the instance ID.

    		pgm-gc7f1****
    ExtensionsstringNo

    The extension that you want to install. If you want to install multiple extensions, separate them with commas (,). If you do not specify the SourceDatabase parameter, you must specify this parameter.

    		citext,pg_profile
    DBNamesstringYes

    The database name. You can call the DescribeDatabases operation to query the database name.

    		test_db
    AccountNamestringYes

    The account of the user who owns the extension. Only privileged accounts are supported.

    		test_user
    SourceDatabasestringNo

    The source database from which you want to synchronize the extension to the destination database. If you do not specify the Extensions parameter, you must specify this parameter.

    		source_db
    ResourceGroupIdstringNo

    The ID of the resource group.

    		rg-acfmy****
    RiskConfirmedbooleanNo

    The risk description that you need to confirm. If your instance runs an outdated minor engine version, installing specific extensions on the instance poses security risks. Proceed with the installation only after you acknowledge these risks. Valid values:

    • true
    • false
    Note For more information about the risks, see Limits on extension creation for ApsaraDB RDS for PostgreSQL instances.
    		true

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The request ID.

    		7E4448A6-9FE6-4474-A0C1-AA7CFC772CAC

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "7E4448A6-9FE6-4474-A0C1-AA7CFC772CAC"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidDBName.FormatSpecified DB name is not valid.The database name is invalid. Specify a valid name. The name can be up to 16 characters in length and can contain lowercase letters, digits, and underscores (_). The name must start with a lowercase letter and end with a lowercase letter or a digit.
    400InvalidParameters.FormatSpecified parameters is not valid.The values of some parameters are invalid.
    400InvalidAccountName.NotFoundSpecified account name does not exist.-
    403IncorrectDBInstanceTypeCurrent DB instance type does not support this operation.The operation failed. The RDS instance is not in a ready state.
    403IncorrectDBInstanceLockModeCurrent DB instance lock mode does not support this operation.The operation failed. The RDS instance is locked.
    403IncorrectDBInstanceStateCurrent DB instance state does not support this operation.-
    403IncorrectAccountPrivilegeTypeCurrent account privilege type does not support this operation.-
    403IncorrectMinorVersionCurrent engine minor version does not support operations.This operation is not supported for the current minor engine version.
    404InvalidDBInstance.NotFoundSpecified instance does not exist or not support.The RDS instance cannot be found, is deleted, or does not support the operation.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2023-12-07The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 403
      delete Error Codes: 404
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: RiskConfirmed
    2023-07-26The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 403 change
      delete Error Codes: 400
      delete Error Codes: 404