该接口用于修改RDS SQL Server数据库属性。
接口说明
适用引擎
- RDS SQL Server
相关功能文档
当前该接口支持的功能为修改 SQL Server 数据库属性、云盘数据归档 OSS，且通过 API 使用数据归档 OSS 功能前，请先在控制台开启数据归档功能。
注意 使用该接口前，请仔细阅读功能文档，确保完全了解使用接口的前提条件及使用后造成的影响后，再进行操作。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| rds:ModifyDatabaseConfig | update |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBInstanceId | string | 是 | 实例 ID。 | rm-t4nnu1my39q****** |
| DBName | string | 是 | 数据库名。 说明
不支持填入多个数据库名称。
| testDB |
| DatabasePropertyName | string | 是 | 期望修改的数据库属性。
| compatibility_level |
| DatabasePropertyValue | string | 是 | 期望修改的数据库属性值。
| 150 |
SQL Server 原生参数名称
| 参数名称 | 允许的值 | 修改时是否需要独占库 | 最低 SQL Server 版本 |
|---|---|---|---|
| compatibility_level | 100 110 120 130 140 150 160 | 否 | SQL Server 2008 |
| parameterization | FORCED SIMPLE | 否 | 所有版本适用 |
| delayed_durability | DISABLED ALLOWED FORCED | 否 | SQL Server 2014 |
| accelerated_database_recovery | ON OFF | 是 | SQL Server 2019 |
| read_committed_snapshot | ON OFF | 是 | SQL Server 2008 |
| page_verify | CHECKSUM TORN_PAGE_DETECTION（不支持修改取值为 TORN_PAGE_DETECTION） | 否 | 所有版本适用 |
| auto_update_statistics | ON OFF | 否 | 所有版本适用 |
| auto_update_statistics_async | ON OFF | 否 | SQL Server 2012 |
| allow_snapshot_isolation | ON OFF | 否 | 所有版本适用 |
| ansi_null_default | ON OFF | 否 | 所有版本适用 |
| ansi_nulls | ON OFF | 否 | 所有版本适用 |
| ansi_warnings | ON OFF | 否 | 所有版本适用 |
| ansi_padding | ON OFF | 否 | 所有版本适用 |
| concat_null_yields_null | ON OFF | 否 | 所有版本适用 |
| recursive_triggers | ON OFF | 否 | 所有版本适用 |
| auto_close | OFF | 否 | 所有版本适用 |
RDS 自定义参数名称
注意 RDS 自定义参数名称使用rds_开头。
| 参数名称 | 允许的值 | 修改时是否需要独占库 | 最低 SQL Server 版本 | 备注 |
|---|---|---|---|---|
| rds_optimize_db_file_grow | 1 | 否 | 所有版本适用 | 将数据库的所有文件增长设置为大小，且大小为 256MB。 |
| rds_set_db_online | 1 | 否 | 所有版本适用 | 允许用户 online，如果数据库已经 online，则跳过。 |
| rds_shrink_database_log | 1 | 否 | 所有版本适用 | 对数据库进行收缩动作，是否收缩成功取决于日志的 log_resue_wait_desc 的状态是否为“Nothing”。 |
| rds_update_db_stats | 1 | 否 | 所有版本适用 | 更新数据库中的统计信息，底层使用 SQL Server 自带存储过程 sp_updatestats。 |
| rds_rebuild_db_index | 1 | 否 | 所有版本适用 | 重新数据库中的所有碎片率大于 50%的非聚集索引，需要满足下述条件： - 数据库大小小于 10G。 - 磁盘剩余空间大于 10G 。 |
返回参数
示例
正常返回示例
JSON格式
{
"Code": "200",
"Message": "successful",
"RequestId": "F5C79A20-E931-5389-BC04-DEBA2D3ABD8D"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 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. | 当前数据库属性不适用于SQL Server大版本。 |
| 400 | InvalidDBInstanceEngineType.Format | the DB instance engine type does not support this operation. | DB实例引擎类型不支持此操作。 |
| 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. | 当前登录名在特定数据库中已经有一个具有相同名称的映射用户。请尝试删除现有用户，然后重试。 |
| 400 | InvalidDiskType | Current disk type does not support this operation. | 当前的磁盘类型不支持该操作 |
| 400 | CurrentInsHasColdDB | The current instance has cold storage db. | 当前实例存在冷存库 |
| 400 | CurrentInsHasColdStorage | Current instance has cold storage. | 当前实例存在冷存储 |
| 400 | ColdDBHasSameNameWithOnlineDB | The instance has cold db and online db with the same name. | 实例存在同名的冷库和在线库 |
| 400 | DiskSpaceInsufficientForColdOperation | 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. | 不能恢复到指定的时间点，因为数据库在这个时间点处于冷存中，请选择一个其他合理的时间。 |
| 400 | InvalidRestoreDB | Unable to restore, because the database is in cold storage now. Please skip this database. | 不能恢复当前的数据库，因为数据库是一个冷存库，请跳过这个数据库 |
| 400 | CurrentDBIsInColdStorage | current db is cold db. | 当前库为冷存库 |
| 400 | ColdDBNumExceedsLimit | the number of cold db exceeds the limit. | 冷库数量超过限制 |
| 400 | Order.ComboInstanceNotAllowOperate | A package instance is not allowed to operate independently. | 套餐实例不允许单独操作。 |
| 400 | Price.PricingPlanResultNotFound | 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. | 您还未通过实名认证，不符合购买条件，请登录费用与成本进行实名认证。 |
| 400 | InsufficientAvailableQuota | Your account quota limit is less than 0, please recharge before trying to purchase. | 您的账户可用额度小于0，请先充值后再尝试购买。 |
| 400 | CommodityServiceCalling.Exception | Failed to call commodity service. | 调用商品服务返回失败。 |
| 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. | 客户您好，阿里云计划对当前地域进行优化调整，该区域云服务将停止运营，为确保您的业务连续性及数据迁移工作的平稳过渡，您目前无法操作新购类型的订单，感谢理解与支持。 |
| 400 | Commodity.InvalidComponent | 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. | 客户您好，澳洲地域裁撤，购买的服务效期不能超过2024.09.30 |
| 400 | Price.CommoditySys | Commodity system call exception. | 商品系统调用异常。 |
| 400 | Pay.InsufficientBalance | Insufficient available balance. | 可用金不足。 |
| 400 | Order.PeriodInvalid | 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. | 您选购的服务存在未支付订单，请支付或作废后再下单。 |
| 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. | 您的基本信息未完善，请在操作前先完善您的基本信息。 |
| 400 | Risk.RiskControlRejection | 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. | 当前接口不支持。 |
| 400 | ContainForbiddenLabelError | There is a label that prohibits placing orders. Please contact your distributor for assistance. | 存在禁止下单的标签，请联系您的分销商处理 |
| 400 | InvalidDBInstanceId.NotFound | The DBInstanceId provided does not exist in records. | 提供的DBInstanceId不存在。 |
| 400 | InvalidInstanceLevel.DiskType | Specified instance level not support request disk type | 当前实例规格不支持该存储类型。 |
| 400 | InvalidParam | Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica. | 指定的 wal_level 参数无效。实例中仍然存在复制槽，因此无法将其设置为replica。 |
| 400 | KmsApiError | User secret key invalid. | 用户密钥失效。 |
| 400 | System.SaleValidateFailed | Sales expression validation system error. | 销售表达式校验系统错误。 |
| 400 | Abs.InvalidAccount.NotFound | account is not found. | 账户不存在。 |
| 400 | SqlExecuteFailedOrTimeout | sql command execution failed or timed out:%s. | sql命令执行失败或执行超时 |
| 400 | ColdData.EngineVersionNotSupport | The current instance engine version not support coldDataEnabled. | 当前实例引擎版本不支持归档冷数据。 |
| 400 | ColdData.MinorVersionNotSupport | The current instance minor version not support coldDataEnabled. | 当前内核版本不支持归档冷数据。 |
| 400 | IncorrectTargetClasscode | The current instance type does not support this operation. | 当前规格不支持此操作。 |
| 400 | InvalidConnectionString.Duplicate | Specified connection string already exists in the RDS. | 链接地址名重复，请重新设置连接字符串。 |
| 400 | RequiredParam.NotFound | Required input param is not found. | 没有传入必要的参数。 |
| 400 | Parameters.Invalid | Parameter error, please check the parameters. | 参数错误，请检查参数。 |
| 400 | BackupPolicyNotSupport | 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. | 实例释放后的归档备份保留策略无效。 |
| 400 | Pay.NoCreditCard | No credit cards. | 无信用卡。 |
| 400 | VpcNetworkTypeNotSupport | The vpc network type instance does not support this operation. | vpc网络类型实例不支持此操作。 |
| 400 | MirrorInsExists | Specified DB instance mirror ins already existed. | 当前数据库实例镜像已存在。 |
| 400 | UnsupportedClassCode | The specified DB instance class stops selling. | 实例规格停止售卖。 |
| 400 | InvalidBackupSet | The specified database does not exist in the backup set. | 备份集中没有指定的数据库。 |
| 400 | OrdTCommodityQueryError | Failed to query for product. | 查询产品失败。 |
| 400 | ProductInstanceReleased | The instance has been released. Please check before placing the order. | 实例已释放，请核实后下单。 |
| 400 | RegionEndTimeDissolvedIndia | 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. | 实例当前存在未支付订单，请支付后重试。 |
| 403 | InvalidReduceDiskSize | The storage capacity after the scale-down must be larger than the used amount. | 缩容目标容量不能小于当前存储空间使用量 |
| 403 | CloudSSDNotSupport | Cloud ssd does not support this operation, please upgrade to essd. | SSD盘不支持此操作，请升级至ESSD。 |
| 403 | InvalidUserOperatorPermission | The user permission does not support this operation. | 用户权限不支持此操作。 |
| 403 | InvalidVswitchId | Specified conn vswitch id is not valid. | 指定的VSwitchId格式不正确或为空 |
| 403 | IncorrectMinorVersion | Current engine minor version does not support operations. | 当前引擎小版本不支持此操作。 |
| 403 | OperationDenied.ZoneResource | There is no available zone for inventory. | 没有可用的库存区域。 |
| 403 | NotInFlowController | Sorry,no permission. | 非集团上云用户不可用，无权限。 |
| 403 | InvalidKmsKey | Kms key is disabled. | Kms key已禁用。 |
| 403 | InvalidInstanceLevel.Malformed | Current DB instance level does not support this operation. | 当前数据库实例级别不支持此操作。 |
| 404 | InvalidClusterKms | The current instance does not authorized to access the Key Management Service. | 当前实例未授权访问密钥管理服务。 |
| 404 | Request.NotFound | The requested resource is not available. | 请求的资源不可用。 |
| 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. | 请求服务失败，请稍后重试。 |
| 500 | RequestMetaDataFailed | 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. | 由于rds api服务失败，请求处理失败。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-05-28 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2024-04-02 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2023-12-25 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2023-11-21 | OpenAPI 错误码发生变更 | 查看变更详情 |