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
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| rds:ModifyDatabaseConfig | update | *DBInstance acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DBInstanceId | string | Yes | The instance ID. | rm-t4nnu1my39qr8**** |
| DBName | string | Yes | The database name. Note
You can specify only one database name.
| testDB |
| DatabasePropertyName | string | Yes | The database property that you want to modify.
| compatibility_level |
| DatabasePropertyValue | string | Yes | The value of the database property that you want to modify.
| 150 |
Native parameters in SQL Server
| Parameter | Valid value | Exclusive lock required on the database to change the value | Minimum version of SQL Server |
|---|---|---|---|
| compatibility_level | 100110120130140150160 | No | SQL Server 2008 |
| parameterization | FORCEDSIMPLE | No | All |
| delayed_durability | DISABLEDALLOWEDFORCED | No | SQL Server 2014 |
| accelerated_database_recovery | ONOFF | Yes | SQL Server 2019 |
| read_committed_snapshot | ONOFF | Yes | SQL Server 2008 |
| page_verify | CHECKSUMTORN_PAGE_DETECTION. You cannot change the value to TORN_PAGE_DETECTION. | No | All |
| auto_update_statistics | ONOFF | No | All |
| auto_update_statistics_async | ONOFF | No | SQL Server 2012 |
| allow_snapshot_isolation | ONOFF | No | All |
| ansi_null_default | ONOFF | No | All |
| ansi_nulls | ONOFF | No | All |
| ansi_warnings | ONOFF | No | All |
| ansi_padding | ONOFF | No | All |
| concat_null_yields_null | ONOFF | No | All |
| recursive_triggers | ONOFF | No | All |
| auto_close | OFF | No | All |
Custom parameters of ApsaraDB RDS
Note The custom parameters of ApsaraDB RDS start with rds_.
| Parameter | Valid value | Exclusive lock required on the database to change the value | Minimum version of SQL Server | Description |
|---|---|---|---|---|
| rds_optimize_db_file_grow | 1 | No | All | The incremental size of all database files. Value: 256. Unit: MB. |
| rds_set_db_online | 1 | No | All | Specifies whether to change the status of the database to Online. If the database is in the Online state, ignore this parameter. |
| rds_shrink_database_log | 1 | No | All | When 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_stats | 1 | No | All | When 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_index | 1 | No | All | If 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
Examples
Sample success responses
JSONformat
{
"Code": "200",
"Message": "success",
"RequestId": "8B993DA9-5272-5414-94E3-4CA8BA0146C2"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | %s | DB Operation Failed:%s. | - |
| 400 | InvalidDatabasePropertyValue | Specified value for the database property is not valid. | - |
| 400 | InvalidDatabaseProperty | Specified name for the database property is not valid. | - |
| 400 | DatabasePropertyModificationFail | Database 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. | - |
| 400 | InvalidDatabaseVersion | Specified database property is not compatible with the SQL Server major version. | - |
| 400 | InvalidDBInstanceEngineType.Format | the DB instance engine type does not support this operation. | This operation is not supported for the database engine of the instance. |
| 400 | UserAlreadyExistInDb | The 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. |
| 400 | InvalidDiskType | Current disk type does not support this operation. | The current disk type does not support this operation |
| 400 | CurrentInsHasColdDB | The current instance has cold storage db. | The current instance has cold storage db. |
| 400 | CurrentInsHasColdStorage | Current instance has cold storage. | The current instance has cold storage enabled. |
| 400 | ColdDBHasSameNameWithOnlineDB | The instance has cold db and online db with the same name. | The instance has cold db and online db with the same name. |
| 400 | DiskSpaceInsufficientForColdOperation | Insufficient disk space to bring db online. | Insufficient disk space to bring db online |
| 400 | InvalidRestoreTimeSpecified | Unable 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. |
| 400 | InvalidRestoreDB | Unable 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. |
| 400 | CurrentDBIsInColdStorage | current db is cold db. | The current db is a cold db |
| 400 | ColdDBNumExceedsLimit | the number of cold db exceeds the limit. | The number of cold db exceeds the limit |
| 400 | Order.ComboInstanceNotAllowOperate | A package instance is not allowed to operate independently. | A package instance is not allowed to operate independently. |
| 400 | Price.PricingPlanResultNotFound | Pricing plan price result not found. | Pricing plan price result 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 passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication. |
| 400 | InsufficientAvailableQuota | Your 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. |
| 400 | CommodityServiceCalling.Exception | Failed to call commodity service. | Failed to call commodity service return. |
| 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. | 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. |
| 400 | Commodity.InvalidComponent | The module you purchased is not legal, please buy it again. | The module you purchased is not legal, please buy 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. | Hello customer, this area has been abolished. |
| 400 | Price.CommoditySys | Commodity system call exception. | Commodity system call exception. |
| 400 | Pay.InsufficientBalance | Insufficient available balance. | Insufficient available balance. |
| 400 | Order.PeriodInvalid | There is a problem with the period you selected, please choose again. | There is a problem with the period you selected, please choose again. |
| 400 | pay.noCreditCard | Account not bound to 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. | There is an unpaid order for the service you have purchased. Please pay or void it before placing the order. |
| 400 | noAvailablePaymentMethod | 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 not complete, please complete your basic information before operation. |
| 400 | Risk.RiskControlRejection | Your account is abnormal, please contact customer service for details. | Your account is abnormal, please contact customer service for details. |
| 400 | BasicInfoUncompleted | Your information is incomplete, Complete your information before the operation. | - |
| 400 | Api.NotSupport | Specified api is not supported. | The current interface does not support. |
| 400 | ContainForbiddenLabelError | There 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. |
| 400 | InvalidDBInstanceId.NotFound | The DBInstanceId provided does not exist in records. | The DBInstanceId provided does not exist. |
| 400 | InvalidInstanceLevel.DiskType | Specified instance level not support request disk type | The current instance type does not support the specified storage type. |
| 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. There is still a copy slot in the instance, 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 system error occurs when the sales expression is verified. |
| 400 | Abs.InvalidAccount.NotFound | account is not found. | The account does not exist. |
| 400 | SqlExecuteFailedOrTimeout | sql command execution failed or timed out:%s. | SQL command execution failed or timed out |
| 400 | ColdData.EngineVersionNotSupport | The current instance engine version not support coldDataEnabled. | The current instance engine version not support coldDataEnabled. |
| 400 | ColdData.MinorVersionNotSupport | The current instance minor version not support coldDataEnabled. | The current instance minor version not support coldDataEnabled. |
| 400 | IncorrectTargetClasscode | The current instance type does not support this operation. | This operation is not supported by the instance type. |
| 400 | InvalidConnectionString.Duplicate | Specified connection string already exists in the RDS. | The link address name is duplicate. Please reset the connection string. |
| 400 | RequiredParam.NotFound | Required input param is not found. | - |
| 400 | Parameters.Invalid | Parameter error, please check the parameters. | Parameter error, please check the parameters. |
| 400 | BackupPolicyNotSupport | Cold 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. |
| 400 | InvalideStatus.Format | The instance status does not support this operation. | - |
| 400 | InvalidReleasedKeepPolicy.Format | Specified Released Keep Policy is not valid. | Specified Released Keep Policy is not valid. |
| 400 | Pay.NoCreditCard | No credit cards. | No credit cards. |
| 400 | VpcNetworkTypeNotSupport | The vpc network type instance does not support this operation. | The vpc network type instance does not support this operation. |
| 400 | MirrorInsExists | Specified DB instance mirror ins already existed. | Specified DB instance mirror ins already existed. |
| 400 | UnsupportedClassCode | The specified DB instance class stops selling. | The specified DB instance class stops selling. |
| 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 product. |
| 400 | ProductInstanceReleased | The instance has been released. Please check before placing the order. | The instance has been released, please verify and place an order. |
| 400 | RegionEndTimeDissolvedIndia | The region is no longer supported. | The region is no longer supported. |
| 403 | InvalidDB.NotFound | Specified db does not exist or DB status does not support. | - |
| 403 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | - |
| 403 | OrderStatus.UnPaid | The specified db instance has unpaid order. | The instance has an unpaid order. Please pay first and try again. |
| 403 | InvalidReduceDiskSize | The 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 |
| 403 | CloudSSDNotSupport | Cloud ssd does not support this operation, please upgrade to essd. | - |
| 403 | InvalidUserOperatorPermission | The user permission does not support this operation. | The user is not authorized to perform this operation. |
| 403 | InvalidVswitchId | Specified conn vswitch id is not valid. | - |
| 403 | IncorrectMinorVersion | Current engine minor version does not support operations. | This operation is not supported for the current minor engine version. |
| 403 | OperationDenied.ZoneResource | There is no available zone for inventory. | There is no available zone for inventory. |
| 403 | NotInFlowController | Sorry,no permission. | Sorry,no permission. |
| 403 | InvalidKmsKey | Kms key is disabled. | - |
| 403 | InvalidInstanceLevel.Malformed | Current DB instance level does not support this operation. | The specified database instance type does not support this operation. |
| 404 | InvalidClusterKms | The current instance does not authorized to access the Key Management Service. | The instance does not have permissions to access Key Management Service (KMS). |
| 404 | Request.NotFound | The requested resource is not available. | The requested resources are unavailable. |
| 404 | HostInfo.NotFound | The specified host info is not found. | - |
| 409 | ConflictingDatabaseOperation | There is already some operation on the database and the current operation should wait till it is done. | - |
| 500 | ExternalFailure | The request processing has failed due to external service failure. | The request processing has failed due to external service failure. |
| 500 | RequestMetaDataFailed | The service request failed. Please try again later or contact service personnel. | The service request failed. Please 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 due to an RDS API failure. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-05-28 | The Error code has changed | View Change Details |
| 2024-04-02 | The Error code has changed | View Change Details |
| 2023-12-25 | The Error code has changed | View Change Details |
| 2023-11-21 | The Error code has changed | View Change Details |