文档

ModifyDatabaseConfig - 修改数据库属性

更新时间:

该接口用于修改RDS SQL Server数据库属性。

接口说明

适用引擎

  • RDS SQL Server

相关功能文档

注意 使用该接口前,请仔细阅读功能文档,确保完全了解使用接口的前提条件及使用后造成的影响后,再进行操作。
SQL Server 数据库高级特性管理

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
DBInstanceIdstring

实例 ID。

rm-t4nnu1my39q******
DBNamestring

数据库名。

说明 不支持填入多个数据库名称。
testDB
DatabasePropertyNamestring

期望修改的数据库属性名称。

compatibility_level
DatabasePropertyValuestring

期望修改的数据库属性值。

150

SQL Server 原生参数名称

参数名称允许的值修改时是否需要独占库最低 SQL Server 版本
compatibility_level100
110
120
130
140
150
160
SQL Server 2008
parameterizationFORCED
SIMPLE
所有版本适用
delayed_durabilityDISABLED
ALLOWED
FORCED
SQL Server 2014
accelerated_database_recoveryON
OFF
SQL Server 2019
read_committed_snapshotON
OFF
SQL Server 2008
page_verify
CHECKSUM
TORN_PAGE_DETECTION(不支持修改取值为 TORN_PAGE_DETECTION)
所有版本适用
auto_update_statisticsON
OFF
所有版本适用
auto_update_statistics_asyncON
OFF
SQL Server 2012
allow_snapshot_isolationON
OFF
所有版本适用
ansi_null_defaultON
OFF
所有版本适用
ansi_nullsON
OFF
所有版本适用
ansi_warningsON
OFF
所有版本适用
ansi_paddingON
OFF
所有版本适用
concat_null_yields_nullON
OFF
所有版本适用
recursive_triggersON
OFF
所有版本适用
auto_closeOFF所有版本适用

RDS 自定义参数名称

注意 RDS 自定义参数名称使用rds_开头。

参数名称允许的值修改时是否需要独占库最低 SQL Server 版本备注
rds_optimize_db_file_grow1所有版本适用将数据库的所有文件增长设置为大小,且大小为 256MB。
rds_set_db_online1所有版本适用允许用户 online,如果数据库已经 online,则跳过。
rds_shrink_database_log1所有版本适用对数据库进行收缩动作,是否收缩成功取决于日志的 log_resue_wait_desc 的状态是否为“Nothing”。
rds_update_db_stats1所有版本适用更新数据库中的统计信息,底层使用 SQL Server 自带存储过程 sp_updatestats。
rds_rebuild_db_index1所有版本适用重新数据库中的所有碎片率大于 50%的非聚集索引,需要满足下述条件:
- 数据库大小小于 10G。
- 磁盘剩余空间大于 10G 。

返回参数

名称类型描述示例值
object

返回参数详情。

RequestIdstring

请求 ID。

F5C79A20-E931-5389-BC04-DEBA2D3ABD8D
Messagestring

返回信息。

successful
Codestring

Code 编码。

200

示例

正常返回示例

JSON格式

{
  "RequestId": "F5C79A20-E931-5389-BC04-DEBA2D3ABD8D",
  "Message": "successful",
  "Code": "200"
}

错误码

HTTP status code错误码错误信息描述
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.当前数据库属性不适用于SQL Server大版本。
400InvalidDBInstanceEngineType.Formatthe DB instance engine type does not support this operation.DB实例引擎类型不支持此操作。
400UserAlreadyExistInDbThe current login already has a mapped user with the same name in the specific database. please try removing the existing user and retrying.当前登录名在特定数据库中已经有一个具有相同名称的映射用户。请尝试删除现有用户,然后重试。
403InvalidDB.NotFoundSpecified db does not exist or DB status does not support.指定的数据库不存在或数据库状态不支持。
403IncorrectDBInstanceStateCurrent DB instance state does not support this operation.当前实例状态不支持此操作。
409ConflictingDatabaseOperationThere is already some operation on the database and the current operation should wait till it is done.当前数据库存在数据库属性修改过程。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-12-25OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:409
2023-11-21OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:409
  • 本页导读 (1)
文档反馈