All Products
Search

This Product

    ApsaraDB RDS:ModifyParameter

    Document Center

    ApsaraDB RDS:ModifyParameter

    Last Updated:Nov 11, 2024

    Modifies the parameter values of an instance.

    Operation description

    Supported database engines

    • MySQL
    • PostgreSQL
    • SQL Server
    • MariaDB

    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.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    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:ModifyParameterupdate
    • DBInstance
      acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    • rds:ResourceTag
    • rds:TLSVersion
    		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 token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

    		ETnLKlblzczshOTUbOCzxxxxxxxxxx
    DBInstanceIdstringYes

    The instance ID.

    		rm-uf6wjk5xxxxxxx
    ParametersstringNo

    The JSON strings of parameters and their values. All the parameter values are of the string type. Format: {"Parameter name 1":"Parameter value 1","Parameter name 2":"Parameter value 2"...}. You can call the DescribeParameterTemplates operation to query parameter names and values.

    Note If you specify this parameter, you do not need to specify ParameterGroupId.
    		{"delayed_insert_timeout":"600","max_length_for_sort_data":"2048"}
    ForcerestartbooleanNo

    Specifies whether to restart the instance for a new parameter value to take effect. Valid values:

    • true: The system forcefully restarts the instance. If a new parameter value takes effect only after the instance restarts, you must set this parameter to true. Otherwise, the new parameter value cannot take effect.
    • false: The system does not forcefully restart the instance.

    Default value: false.

    		false
    ParameterGroupIdstringNo

    The parameter template ID.

    Note
  • If you specify this parameter, you do not need to specify Parameters.
  • If the parameter template can be applied only after the instance is restarted, you must specify Forcerestart.
    •
    		rpg-xxxxxxxxx
    SwitchTimeModestringNo

    The time at which the modification takes effect. Valid values:

    • Immediate: immediately modifies the parameter. This is the default value.
    • MaintainTime: modifies the parameter during the maintenance window of the instance. You can call the ModifyDBInstanceMaintainTime operation to change the maintenance window.
    • ScheduleTime: modifies the parameter at the point in time that you specify. If you specify this value, you must also specify SwitchTime.
    Enumeration Value:
    • ScheduleTime: modifies the parameter at the point in time that you specify. If you specify this value, you must also specify SwitchTime.
    • Immediate: immediately modifies the parameter.
    • MaintainTime: modifies the parameter during the maintenance window of the instance. You can call the ModifyDBInstanceMaintainTime operation to change the maintenance window.
    		ScheduleTime
    SwitchTimestringNo

    The time at which the modification takes effect. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

    Note This time must be later than the time at which you call this operation.
    		2022-05-06T09:24:00Z

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The ID of the request.

    		542BB8D6-4268-45CC-A557-B03EFD7AB30A

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "542BB8D6-4268-45CC-A557-B03EFD7AB30A"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400PendingActionOverduethe action execution time is already overdueThe specified execution time has expired.
    400EngineMigration.ActionDisabledSpecified action is disabled while custins is in engine migration.The specified operation is disabled when the instance is being migrated across engines.
    400%sThe following parameters are prohibited: <br />%s-
    400Invalid.ParamGroupDBCategoryParamGroup category is basic, not standard.The parameter group is a basic parameter group not a standard parameter group.
    400InvalidEffectiveTime.SpecialTimeIsNullSpecialTime is not valid.-
    400InvalidParameters.FormatSpecified parameters is not valid.The values of some parameters are invalid.
    400StorageEngine.NotSupportedCurrent instance storage engine dose not support this operation.-
    400InvalideStatus.FormatThe instance status does not support this operation.-
    400SystemParamGroupCode.FormatSpecific DBParamGroupId is not valid.-
    400Database.ConnectErrorDatabase connect error. please check instance status and database processlistA database connection error occurred. Check the instance state and the database connection pool.
    400InvalidInstanceParameterSpecified name for the instance parameter is not valid.The name specified for the instance parameter is invalid.
    400GroupReplicationNotSupport.InvalidParametersGroup Replication limits parameters and does not support modification.The group Replication has restrictions on parameters and cannot be modified.
    400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.A package instance is not allowed to operate independently.
    400Price.PricingPlanResultNotFoundPricing plan price result not found.Pricing plan price result not found.
    400Order.NoRealNameAuthenticationYou 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 passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.
    400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.Your account available limit is less than 0, please recharge before trying to purchase.
    400CommodityServiceCalling.ExceptionFailed to call commodity service.Failed to call commodity service return.
    400RegionDissolvedEOMDear 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.Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.
    400Commodity.InvalidComponentThe module you purchased is not legal, please buy it again.The module you purchased is not legal, please buy it again.
    400RegionEndTimeDissolvedIndiaCloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.Hello customer, this area has been abolished.
    400RegionEndTimeDissolvedAustraliaCloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.
    400Price.CommoditySysCommodity system call exception.Commodity system call exception.
    400Pay.InsufficientBalanceInsufficient available balance.Insufficient available balance.
    400Order.PeriodInvalidThere is a problem with the period you selected, please choose again.There is a problem with the period you selected, please choose again.
    400pay.noCreditCardAccount not bound to credit card.-
    400Order.InstHasUnpaidOrderThere is an unpaid order for the service you have purchased. Please pay or void it before placing the order.There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
    400noAvailablePaymentMethodNo payment method is specified for your account. We recommend that you add a payment method.-
    400BasicInfoUncompletedYour information is incomplete. Complete your information before the operation.Your basic information is not complete, please complete your basic information before operation.
    400Risk.RiskControlRejectionYour account is abnormal, please contact customer service for details.Your account is abnormal, please contact customer service for details.
    400BasicInfoUncompletedYour information is incomplete, Complete your information before the operation.-
    400Api.NotSupportSpecified api is not supported.The current interface does not support.
    400ContainForbiddenLabelErrorThere is a label that prohibits placing orders. Please contact your distributor for assistance.You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.
    400InvalidDBInstanceId.NotFoundThe DBInstanceId provided does not exist in records.The DBInstanceId provided does not exist.
    400InvalidInstanceLevel.DiskTypeSpecified instance level not support request disk typeThe current instance type does not support the specified storage type.
    400InvalidParamSepcified 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. There is still a copy slot in the instance, so it cannot be set to replica.
    400KmsApiErrorUser secret key invalid.The user key is invalid.
    400System.SaleValidateFailedSales expression validation system error.A system error occurs when the sales expression is verified.
    400Abs.InvalidAccount.NotFoundaccount is not found.The account does not exist.
    400SqlExecuteFailedOrTimeoutsql command execution failed or timed out:%s.SQL command execution failed or timed out
    400ColdData.EngineVersionNotSupportThe current instance engine version not support coldDataEnabled.The current instance engine version not support coldDataEnabled.
    400ColdData.MinorVersionNotSupportThe current instance minor version not support coldDataEnabled.The current instance minor version not support coldDataEnabled.
    400IncorrectTargetClasscodeThe current instance type does not support this operation.This operation is not supported by the instance type.
    400InvalidConnectionString.DuplicateSpecified connection string already exists in the RDS.The link address name is duplicate. Please reset the connection string.
    400RequiredParam.NotFoundRequired input param is not found.-
    400Parameters.InvalidParameter error, please check the parameters.Parameter error, please check the parameters.
    400BackupPolicyNotSupportCold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.
    400InvalidReleasedKeepPolicy.FormatSpecified Released Keep Policy is not valid.Specified Released Keep Policy is not valid.
    400InvalidDBInstanceEngineType.Formatthe DB instance engine type does not support this operation.This operation is not supported for the database engine of the instance.
    400Pay.NoCreditCardNo credit cards.No credit cards.
    400VpcNetworkTypeNotSupportThe vpc network type instance does not support this operation.The vpc network type instance does not support this operation.
    400MirrorInsExistsSpecified DB instance mirror ins already existed.Specified DB instance mirror ins already existed.
    400UnsupportedClassCodeThe specified DB instance class stops selling.The specified DB instance class stops selling.
    400InvalidBackupSetThe specified database does not exist in the backup set.The specified database does not exist in the backup set.
    400OrdTCommodityQueryErrorFailed to query for product.Failed to query product.
    400ProductInstanceReleasedThe instance has been released. Please check before placing the order.The instance has been released, please verify and place an order.
    403IncorrectDBInstanceTypeThe current database instance type does not support the operation.This operation is not supported for the database engine of the current instance.
    403IncorrectDBInstanceStateThe current database status does not support the operation.The operation failed. The RDS instance is not running.
    403ParamNotSupportedForCurrentVersionParameter is not supported for current version.-
    403Invalid.ParameterSpecified parameters is not valid.The specified parameter is invalid.
    403IncorrectEffectiveTimeThe specified EffectiveTime params is not valid.The value of the EffectiveTime parameter is invalid.
    403GroupReplicationNotSupport.InvalidEngineVersionGroup Replication requires the instance engine version to be 8.0.-
    403GroupReplicationNotSupport.InvalidNodeClassCodeGroup Replication requires the ClassCode of each node to be consistent.-
    403GroupReplicationNotSupport.InvalidNodeNumGroup Replication is not supported, the number of nodes must be an odd number greater than or equal to 3.-
    403GroupReplicationNotSupport.InvalidXengineGroup Replication is not supported because the instance has xengine tables.-
    403GroupReplicationNotSupport.MemoryTooSmallGroup Replication is not supported because the memory is too small.-
    403IncorrectMinorVersionCurrent engine minor version does not support operations.This operation is not supported for the current minor engine version.
    403GroupReplicationNotSupport.TableWithoutPrimaryKeyGroup Replication is not supported because the instance exists table has no primary key.The instance has tables without primary keys and does not support MySQL group replication (MGR).
    403IncorrectDBInstanceThe current DB instance does not support this operation.The operation failed. The operation is not supported for the RDS instance.
    403OrderStatus.UnPaidThe specified db instance has unpaid order.The instance has an unpaid order. Please pay first and try again.
    403InvalidReduceDiskSizeThe storage capacity after the scale-down must be larger than the used amount.The scale-in target capacity cannot be less than the current storage space usage
    403CloudSSDNotSupportCloud ssd does not support this operation, please upgrade to essd.-
    403InvalidUserOperatorPermissionThe user permission does not support this operation.The user is not authorized to perform this operation.
    403InvalidVswitchIdSpecified conn vswitch id is not valid.-
    403OperationDenied.ZoneResourceThere is no available zone for inventory.There is no available zone for inventory.
    403NotInFlowControllerSorry,no permission.Sorry,no permission.
    403InvalidKmsKeyKms key is disabled.-
    403InvalidInstanceLevel.MalformedCurrent DB instance level does not support this operation.The specified database instance type does not support this operation.
    404InvalidDBInstance.NotFoundThe specified instance does not exist or is not supported.The RDS instance cannot be found. Check the ID or name of the RDS instance.
    404InvalidParamSepcified wal_level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.-
    404InvalidClusterKmsThe current instance does not authorized to access the Key Management Service.The instance does not have permissions to access Key Management Service (KMS).
    404Request.NotFoundThe requested resource is not available.The requested resources are unavailable.
    404HostInfo.NotFoundThe specified host info is not found.-
    500ExternalFailureThe request processing has failed due to external service failure.The request processing has failed due to external service failure.
    500RequestMetaDataFailedThe service request failed. Please try again later or contact service personnel.The service request failed. Please try again later or contact service personnel.
    500InvokeProxyFailureThe request processing has failed due to service failure of rds api.The request failed to be processed due to an RDS API failure.

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

    Change history

    Change timeSummary of changesOperation
    2024-08-22The Error code has changedView Change Details
    2024-07-23The Error code has changedView Change Details
    2024-06-03The Error code has changedView Change Details
    2024-05-27The Error code has changedView Change Details
    2023-12-21The Error code has changedView Change Details
    2023-06-28The Error code has changedView Change Details
    2023-06-20The Error code has changedView Change Details
    2023-05-09The Error code has changedView Change Details
    2023-04-25The Error code has changedView Change Details
    2022-10-28The Error code has changedView Change Details
    2021-10-26The Error code has changedView Change Details
    2021-10-26The Error code has changed. The request parameters of the API has changedView Change Details
    2021-10-26The Error code has changedView Change Details