該介面用於修改RDS SQL Server資料庫屬性。
介面說明
適用引擎
RDS SQL Server
相關功能文檔
當前該介面支援的功能為修改 SQL Server 資料庫屬性、雲端硬碟資料歸檔 OSS，且通過 API 使用資料歸檔 OSS 功能前，請先在控制台開啟資料歸檔功能。
重要 使用該介面前，請仔細閱讀功能文檔，確保完全瞭解使用介面的前提條件及使用後造成的影響後，再進行操作。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
rds:ModifyDatabaseConfig |
update |
*DBInstance
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| 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 。 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回參數詳情。 |
||
| Code |
string |
Code 編碼。 |
200 |
| Message |
string |
返回資訊。 |
successful |
| RequestId |
string |
請求 ID。 |
F5C79A20-E931-5389-BC04-DEBA2D3ABD8D |
樣本
正常返回樣本
JSON格式
{
"Code": "200",
"Message": "successful",
"RequestId": "F5C79A20-E931-5389-BC04-DEBA2D3ABD8D"
}錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | SqlExecuteFailedOrTimeout | %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. | 客戶您好，該地區已裁撤。 |
| 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 | 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 | 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. | 指定的地區無效。 |
| 400 | InvalidCharacter.DbOrAccount | The database name or account name contains invalid characters. | 資料庫名稱或者帳號名稱包含非法字元。 |
| 400 | StatisticsUpdateNotSupported | Updating statistics is not supported. | 不支援更新統計資料。 |
| 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服務失敗，請求處理失敗。 |
| 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. | 當前資料庫存在資料庫屬性修改過程。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。