All Products
Search
Document Center

ApsaraDB RDS:ModifyDatabaseConfig

最終更新日:Nov 01, 2024

Modifies the property settings of an ApsaraDB RDS for SQL Server instance.

Operation description

Supported database engine

  • SQL Server

References

You can call this operation to modify the database properties of an ApsaraDB RDS for SQL Server instance and archive data from an instance that uses cloud disks to an Object Storage Service (OSS) bucket. Before you call this operation to archive data to an OSS bucket, you must enable the data archiving feature in the ApsaraDB RDS console. For more information, see Modify database properties and Archive cloud disk data to an OSS bucket.

Note Before you call this operation, read the following topics and make sure that you fully understand the prerequisites and impacts of 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:ModifyDatabaseConfigupdate
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The instance ID.

rm-t4nnu1my39qr8****
DBNamestringYes

The database name.

Note You can specify only one database name.
testDB
DatabasePropertyNamestringYes

The database property that you want to modify.

  • If you want to modify a property of the database, set this parameter to the name of the database property.
  • If you want to archive data from the database to an OSS bucket, specify the database status. If you set this parameter to covert_online_db_to_cold_storage, the system converts an online database to a cold storage database. If you set this parameter to convert_cold_storage_db_to_online, the system converts a cold storage database to an online database.
compatibility_level
DatabasePropertyValuestringYes

The value of the database property that you want to modify.

  • If you want to modify a property of the database, set this parameter to the property value.
  • If you want to archive data from the database to an OSS bucket, set this parameter to 1. The system converts a database to a cold storage database or an online database.
150

Native parameters in SQL Server

ParameterValid valueExclusive lock required on the database to change the valueMinimum version of SQL Server
compatibility_level100110120130140150160NoSQL Server 2008
parameterizationFORCEDSIMPLENoAll
delayed_durabilityDISABLEDALLOWEDFORCEDNoSQL Server 2014
accelerated_database_recoveryONOFFYesSQL Server 2019
read_committed_snapshotONOFFYesSQL Server 2008
page_verifyCHECKSUMTORN_PAGE_DETECTION. You cannot change the value to TORN_PAGE_DETECTION.NoAll
auto_update_statisticsONOFFNoAll
auto_update_statistics_asyncONOFFNoSQL Server 2012
allow_snapshot_isolationONOFFNoAll
ansi_null_defaultONOFFNoAll
ansi_nullsONOFFNoAll
ansi_warningsONOFFNoAll
ansi_paddingONOFFNoAll
concat_null_yields_nullONOFFNoAll
recursive_triggersONOFFNoAll
auto_closeOFFNoAll

Custom parameters of ApsaraDB RDS

Note The custom parameters of ApsaraDB RDS start with rds_.

ParameterValid valueExclusive lock required on the database to change the valueMinimum version of SQL ServerDescription
rds_optimize_db_file_grow1NoAllThe incremental size of all database files. Value: 256. Unit: MB.
rds_set_db_online1NoAllSpecifies whether to change the status of the database to Online. If the database is in the Online state, ignore this parameter.
rds_shrink_database_log1NoAllWhen the shrinkage operation is performed on the database, whether the shrinkage is successful depends on whether log_resue_wait_desc of the log is set to Nothing.
rds_update_db_stats1NoAllWhen the statistics in the database is updated, the underlying layer uses the sp_updatestats stored procedure that is built in SQL Server.
rds_rebuild_db_index1NoAllIf you want to update all non-clustered indexes whose fragmentation rate is greater than 50% in the database, make sure that the following conditions are met:-The database size is less than 10 GB.-The remaining disk space is greater than 10 GB.

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

Codestring

The code.

200
Messagestring

The message returned.

success
RequestIdstring

The request ID.

8B993DA9-5272-5414-94E3-4CA8BA0146C2

Examples

Sample success responses

JSONformat

{
  "Code": "200",
  "Message": "success",
  "RequestId": "8B993DA9-5272-5414-94E3-4CA8BA0146C2"
}

Error codes

HTTP status codeError codeError messageDescription
400%sDB Operation Failed:%s.-
400InvalidDatabasePropertyValueSpecified value for the database property is not valid.-
400InvalidDatabasePropertySpecified name for the database property is not valid.-
400DatabasePropertyModificationFailDatabase property modification failed, possibly due to high workload on the database or inability to obtain an exclusive lock. Please attempt to modify the property during periods of low workload.-
400InvalidDatabaseVersionSpecified database property is not compatible with the SQL Server major version.-
400InvalidDBInstanceEngineType.Formatthe DB instance engine type does not support this operation.This operation is not supported for the database engine of the instance.
400UserAlreadyExistInDbThe current login already has a mapped user with the same name in the specific database. please try removing the existing user and retrying.The current login already has a mapped user with the same name in the specific database. Try deleting the existing user and try again.
400InvalidDiskTypeCurrent disk type does not support this operation.The current disk type does not support this operation
400CurrentInsHasColdDBThe current instance has cold storage db.The current instance has cold storage db.
400CurrentInsHasColdStorageCurrent instance has cold storage.The current instance has cold storage enabled.
400ColdDBHasSameNameWithOnlineDBThe instance has cold db and online db with the same name.The instance has cold db and online db with the same name.
400DiskSpaceInsufficientForColdOperationInsufficient disk space to bring db online.Insufficient disk space to bring db online
400InvalidRestoreTimeSpecifiedUnable to restore to the specified time, because the database is in cold storage at this time. Please choose a valid restore point.Unable to restore to the specified time, because the database is in cold storage at this time. Please choose a valid restore point.
400InvalidRestoreDBUnable to restore, because the database is in cold storage now. Please skip this database.Unable to restore, because the database is in cold storage now. Please skip this database.
400CurrentDBIsInColdStoragecurrent db is cold db.The current db is a cold db
400ColdDBNumExceedsLimitthe number of cold db exceeds the limit.The number of cold db exceeds the limit
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.
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.
400InvalideStatus.FormatThe instance status does not support this operation.-
400InvalidReleasedKeepPolicy.FormatSpecified Released Keep Policy is not valid.Specified Released Keep Policy is not valid.
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.
400RegionEndTimeDissolvedIndiaThe region is no longer supported.The region is no longer supported.
403InvalidDB.NotFoundSpecified db does not exist or DB status does not support.-
403IncorrectDBInstanceStateCurrent DB instance state does not support this operation.-
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.-
403IncorrectMinorVersionCurrent engine minor version does not support operations.This operation is not supported for the current minor engine version.
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.
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.-
409ConflictingDatabaseOperationThere is already some operation on the database and the current operation should wait till it is done.-
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-05-28The Error code has changedView Change Details
2024-04-02The Error code has changedView Change Details
2023-12-25The Error code has changedView Change Details
2023-11-21The Error code has changedView Change Details