All Products
Search

This Product

    ApsaraDB RDS:ModifyDBInstanceConfig - Modify the configuration items of an RDS instance

    Document Center

    ApsaraDB RDS:ModifyDBInstanceConfig - Modify the configuration items of an RDS instance

    Last Updated:Aug 28, 2026

    You can call this operation to modify the configuration items of an RDS instance.

    Description

    Applicable database engines

    • RDS PostgreSQL
    • RDS SQL Server

    Debugging

    You can call this operation in OpenAPI Explorer to simplify request signing. Upon successful execution, OpenAPI Explorer automatically generates sample code for the software development kit (SDK).

    Authorization

    The following table describes the authorization information for this API operation. You can add this information to the Action element of a RAM policy statement to grant a RAM user or RAM role the permission to call this API operation.

    • Operation: The specific permission.
    • Access level: The access level of the operation. Valid values: Write, Read, and List.
    • Resource type: The type of resource that can be authorized. The following rules apply:
      • Required resource types are marked with an asterisk (*).
      • If the operation does not support resource-level authorization, the value is All Resources.
    • Condition key: The condition keys defined by the Alibaba Cloud service.
    • Associated operation: Other operations that are required to call this operation. You must also have permission to call the associated operations.
    Operation Access level Resource type Condition key Associated operation
    rds:ModifyDBInstanceConfig none
    *DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}
      None
    		 None

    Request parameters

    Name Type Required Description Example
    DBInstanceId string Yes

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

    		 pgm-2ze****
    ConfigName string Yes

    The name of the configuration item to modify. Use this parameter with ConfigValue.

    RDS PostgreSQL configuration items
    • pgbouncer: Modifies the PgBouncer feature.
    • encryptionKey: Modifies the disk encryption feature.
    • duckdb_create_databases: Configures databases of the primary instance as DuckDB column-store databases in batches.
    • duckdb_prepare_dependency: Configures the parameters and minor engine version of the primary instance with a single click to meet the prerequisites for creating a DuckDB analysis instance. If the primary instance has read-only instances, the read-only instances are also modified.
    • enable_db_visible_by_connect_rls: Enables CONNECT RLS to control database visibility for the instance.
    • set_db_visible_by_connect_rls: Enables CONNECT RLS to control database visibility for a database. This can be called only after CONNECT RLS is enabled for the instance.
    RDS SQL Server configuration items
    • clear_errorlog: Clears error logs.
    • encryptionKey: Modifies the disk encryption feature. Serverless instances and instances with shared instance types do not support this feature.
    		 pgbouncer
    ConfigValue string Yes

    The value of the configuration item to modify. Use this parameter with ConfigName.

    Values for RDS PostgreSQL configuration items
    • PgBouncer feature: true (enable) or false (disable).
    • Disk encryption feature:
      • ServiceKey: Uses a key that is automatically generated by Alibaba Cloud. This means you use the default service customer master key (CMK) managed by RDS to enable disk encryption.
      • <key>: Uses a custom key to enable disk encryption or replace the current key. Example: 494c98ce-f2b5-48ab-96ab-36c986b6****.
      • disabled: Disables disk encryption.
    • One-click fix for the prerequisites to create a DuckDB analysis instance: duckdb_prepare_dependency
    • Batch configure databases of the primary instance as DuckDB column-store databases. This is a JSON string. Example: {"dbNames": "db1,db2,db3", "accountName": "yourSuperAccountName"}.
      • dbNames: The names of the databases to convert to DuckDB column-store databases. Separate multiple database names with commas (,).
      • accountName: The privileged account. You only need to configure one privileged account.
    • Enable CONNECT RLS to control database visibility for the instance: true to enable.
    • Enable CONNECT RLS to control database visibility for a database: The names of the databases managed by CONNECT RLS. Separate multiple database names with commas (,). Example: testdb1,testdb2. When a client connects to a database with CONNECT RLS enabled, the list of databases is displayed correctly based on whether the client has CONNECT permissions on other databases.
    Values for RDS SQL Server configuration items
    • Error log cleanup feature: 1 (confirm cleanup).
    • Disk encryption feature (This feature cannot be disabled after it is enabled):
      • serviceKey: Uses a key that is automatically generated by Alibaba Cloud. This means you use the default service CMK managed by RDS to enable disk encryption.
      • <key>: Uses a custom key to enable disk encryption or replace the current key. Example: 494c98ce-f2b5-48ab-96ab-36c986b6****.
    		 true
    ResourceGroupId string No

    The resource group ID. You can call the DescribeDBInstanceAttribute operation to query the resource group ID.

    		 rg-bp67acfmxazb4p****
    ClientToken string No

    A 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 token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

    		 6000170000591aed949d0f****
    SwitchTime string No

    The time when you want to apply the modification. We recommend that you perform the modification during off-peak hours. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

    		 2025-05-06T09:24:00Z
    SwitchTimeMode string No

    The switching time. Valid values:

    • Immediate: The modification takes effect immediately.
    • MaintainTime: The modification takes effect within the maintenance window. You can call the ModifyDBInstanceMaintainTime operation to change the maintenance window.
    		 Immediate

    Response parameters

    Name Type Description Example
    object

    The response parameters.
    RequestId string

    The request ID.

    		 76364A52-E0AB-5CC8-9818-CF1DC482C092

    Examples

    Sample response

    JSON format

    {
  "RequestId": "76364A52-E0AB-5CC8-9818-CF1DC482C092"
}

    Error codes

    HTTP status code Error code Error message Description
    400 %s DB Operation Failed:%s. -
    400 InvalidDBInstanceName.NotFound The specified DB instance name does not exist. The specified database instance name does not exist. Check the name.
    400 MinorVersionNotSupport The current database minor version does not support the operation. The current minor engine version of the instance does not support this operation. You can try to upgrade the minor engine version.
    400 InvalidConfigName The ConfigName is not valid. The ConfigName is invalid.
    400 Order.ComboInstanceNotAllowOperate A package instance is not allowed to operate independently. Package instances cannot be operated on independently.
    400 Price.PricingPlanResultNotFound Pricing plan price result not found. The pricing plan price was not found.
    400 Order.NoRealNameAuthentication You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication. You have not completed identity verification and do not meet the purchase requirements. Log on to the Expenses and Costs page to complete identity verification.
    400 InsufficientAvailableQuota Your account quota limit is less than 0, please recharge before trying to purchase. Your account has a balance of less than 0. Top up your account before you try to make a purchase.
    400 CommodityServiceCalling.Exception Failed to call commodity service. The call to the commodity service failed.
    400 RegionDissolvedEOM Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support. Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. To ensure your business continuity and a smooth data migration, you cannot create new purchase orders. Thank you for your understanding and support.
    400 Commodity.InvalidComponent The module you purchased is not legal, please buy it again. The module you purchased is invalid. Purchase it again.
    400 RegionEndTimeDissolvedAustralia Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024. Dear customer, this region has been decommissioned.
    400 Price.CommoditySys Commodity system call exception. An exception occurred when calling the commodity system.
    400 Pay.InsufficientBalance Insufficient available balance. The available balance is insufficient.
    400 Order.PeriodInvalid There is a problem with the period you selected, please choose again. The subscription period you selected is invalid. Select a valid period.
    400 pay.noCreditCard Account not bound to credit card. The account is not linked to a credit card.
    400 Order.InstHasUnpaidOrder There is an unpaid order for the service you have purchased. Please pay or void it before placing the order. The service you purchased has an unpaid order. Pay for or cancel the order before placing a new one.
    400 noAvailablePaymentMethod No payment method is specified for your account. We recommend that you add a payment method. No payment method is specified for your account. We recommend that you add a payment method.
    400 BasicInfoUncompleted Your information is incomplete. Complete your information before the operation. Your basic information is incomplete. Complete your information before the operation.
    400 Risk.RiskControlRejection Your account is abnormal, please contact customer service for details. Your account is abnormal. For details, contact customer service.
    400 BasicInfoUncompleted Your information is incomplete, Complete your information before the operation. Your information is incomplete. Complete your information before the operation.
    400 Api.NotSupport Specified api is not supported. This API operation is not supported.
    400 ContainForbiddenLabelError There is a label that prohibits placing orders. Please contact your distributor for assistance. The instance has a tag that prohibits placing orders. Contact your distributor for assistance.
    400 InvalidDBInstanceId.NotFound The DBInstanceId provided does not exist in records. The specified DBInstanceId does not exist.
    400 InvalidInstanceLevel.DiskType Specified instance level not support request disk type The current instance type does not support this storage class.
    400 InvalidParam Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica. The specified wal_level parameter is invalid. The instance still has replication slots, so it cannot be set to replica.
    400 KmsApiError User secret key invalid. The user key is invalid.
    400 System.SaleValidateFailed Sales expression validation system error. A sales expression validation system error occurred.
    400 Abs.InvalidAccount.NotFound account is not found. The account does not exist.
    400 SqlExecuteFailedOrTimeout sql command execution failed or timed out:%s. The SQL command failed to execute or timed out.
    400 ColdData.EngineVersionNotSupport The current instance engine version not support coldDataEnabled. The current engine version of the instance does not support archiving cold data.
    400 ColdData.MinorVersionNotSupport The current instance minor version not support coldDataEnabled. The current minor version does not support archiving cold data.
    400 IncorrectTargetClasscode The current instance type does not support this operation. The current instance type does not support this operation.
    400 InvalidConnectionString.Duplicate Specified connection string already exists in the RDS. The connection string already exists. Set a new connection string.
    400 RequiredParam.NotFound Required input param is not found. A required parameter is missing.
    400 Parameters.Invalid Parameter error, please check the parameters. The parameters are invalid. Check the parameters.
    400 BackupPolicyNotSupport Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy. Data archiving does not support cross-region backup or snapshot backups that are created per second. Check the backup policy.
    400 InvalideStatus.Format The instance status does not support this operation. The instance is in a state that does not support this operation.
    400 InvalidReleasedKeepPolicy.Format Specified Released Keep Policy is not valid. The retention policy for archived backups after the instance is released is invalid.
    400 InvalidDBInstanceEngineType.Format the DB instance engine type does not support this operation. The database engine of the instance does not support this operation.
    400 Pay.NoCreditCard No credit cards. No credit card is linked to the account.
    400 VpcNetworkTypeNotSupport The vpc network type instance does not support this operation. Instances that reside in a VPC do not support this operation.
    400 MirrorInsExists Specified DB instance mirror ins already existed. A mirror image for the database instance already exists.
    400 UnsupportedClassCode The specified DB instance class stops selling. The specified instance type is no longer available for purchase.
    400 InvalidBackupSet The specified database does not exist in the backup set. The specified database does not exist in the backup set.
    400 OrdTCommodityQueryError Failed to query for product. Failed to query the product.
    400 ProductInstanceReleased The instance has been released. Please check before placing the order. The instance has been released. Verify the instance status before you place an order.
    400 RegionEndTimeDissolvedIndia The region is no longer supported. The specified region is invalid.
    400 InvalidSourceCategory specified source category is invalid. The specified source category is invalid.
    400 InvalidParameter Invalid parameter. The parameter is invalid.
    400 InvalidConfigValue The ConfigValue is not valid. The operation failed. The specified parameter configuration is invalid.
    400 InvalidParameters.Format Specified parameters is not valid. The parameters are invalid.
    403 IncorrectDBInstanceType Current DB instance type does not support this operation. The operation failed. The instance is in a state that does not support this operation.
    403 IncorrectDBInstanceLockMode Current DB instance lock mode does not support this operation. The operation failed. The instance is locked.
    403 IncorrectDBInstanceState Current DB instance state does not support this operation. The current instance status does not support this operation.
    403 CloudDiskEncryptionNotSupport The encryption key is not allowed for general-purpose instance. General-purpose instances do not support disk encryption.
    403 OrderStatus.UnPaid The specified db instance has unpaid order. The instance has an unpaid order. Pay for the order and try again.
    403 InvalidReduceDiskSize The storage capacity after the scale-down must be larger than the used amount. The storage capacity after the scale-in cannot be smaller than the used storage space.
    403 CloudSSDNotSupport Cloud ssd does not support this operation, please upgrade to essd. Standard SSDs do not support this operation. Upgrade to an ESSD.
    403 InvalidUserOperatorPermission The user permission does not support this operation. The user does not have the permissions to perform this operation.
    403 InvalidVswitchId Specified conn vswitch id is not valid. The specified VSwitchId is empty or in an invalid format.
    403 IncorrectMinorVersion Current engine minor version does not support operations. The current minor engine version does not support this operation.
    403 OperationDenied.ZoneResource There is no available zone for inventory. No inventory is available in the zone.
    403 NotInFlowController Sorry,no permission. This operation is not available to users who are not part of the Alibaba Group cloud migration program. You do not have the required permissions.
    403 InvalidKmsKey Kms key is disabled. The KMS key is disabled.
    403 InvalidInstanceLevel.Malformed Current DB instance level does not support this operation. The current database instance level does not support this operation.
    403 UnsupportedByBlueGreenDeployment Operation prohibited due to blue green deployment. The operation is not allowed because a blue-green deployment is in progress.
    403 EncryptionKeyNotSupport The encryption key is not support to generate encryption disk. The key cannot be used to create an instance with disk encryption enabled.
    403 IncorrectDBState The current DB state does not support this operation. The operation failed because the database is in an invalid state. For example, the database is being created or migrated to the cloud.
    403 UnsupportedReadOrBakReadState Current DB instance has read or bak read running in unsupport states The current DB instance is running a read or backup read operation in an unsupported state.
    403 IncorrectAccountPrivilegeType the current account privilege type does not support this operation. The privilege type of the current account does not support this operation.
    403 DBInstanceStatusNotActive The status of the current instance is not active. The operation failed. Check the running status of the instance.
    403 ReadOnlyInstanceNotSupport Read-only instance does not support this operation. Read-only instances do not support this operation.
    403 Invalid.Parameter Specified parameters is not valid. The specified parameter is invalid.
    403 TargetMajorVesionNotSupported The specified major version is not supported. The target major version is not supported.
    403 ReadInstanceNotSupport Instances with read-only do not support this operation. Instances with read-only instances do not support this operation.
    404 InvalidDBInstance.NotFound Specified instance does not exist or not support. The specified instance does not exist, has been deleted, or does not support the current operation.
    404 InvalidClusterKms The current instance does not authorized to access the Key Management Service. The current instance is not authorized to access Key Management Service (KMS).
    404 Request.NotFound The requested resource is not available. The requested resource is not available.
    404 HostInfo.NotFound The specified host info is not found. The specified host information is not found.
    404 InvalidAccountName.NotFound The specified account is not found. The specified account is not found. If you are creating an account or resetting a password, specify the account.
    404 InvalidReadDBInstance.NotFound The specified read only database instance does not exist. The read-only instance is not created or the request parameters for the instance are invalid.
    500 ExternalFailure The request processing has failed due to external service failure. The request failed. Try again later.
    500 RequestMetaDataFailed The service request failed. Please try again later or contact service personnel. The service request failed. Try again later or contact service personnel.
    500 InvokeProxyFailure The request processing has failed due to service failure of rds api. The request failed to be processed because the RDS API service failed.

    For more information about error codes, see the Error Center.

    Change history

    Update time Change summary Operations
    2025-10-30 The OpenAPI error codes are changed. View change details
    2025-10-28 The OpenAPI error codes are changed. View change details
    2025-03-31 The OpenAPI error codes are changed. View change details
    2025-03-25 The OpenAPI error codes are changed. View change details
    2024-12-26 The OpenAPI error codes are changed. View change details
    2024-12-12 The OpenAPI error codes and request parameters are changed. View change details
    2024-09-24 The OpenAPI error codes are changed. View change details
    2024-05-28 The OpenAPI error codes are changed. View change details
    2023-11-21 The OpenAPI error codes are changed. View change details