全部產品
Search

搜尋本產品

    ApsaraDB RDS：ModifyParameter - 修改執行個體參數

    文件中心

    ApsaraDB RDS：ModifyParameter - 修改執行個體參數

    更新時間：Apr 18, 2026

    該介面用於修改RDS執行個體的參數值。

    介面說明

    適用引擎

    • RDS MySQL

    • RDS PostgreSQL

    • RDS SQL Server

    • RDS MariaDB

    相關功能文檔

    重要 使用該介面前，請仔細閱讀功能文檔，確保完全瞭解使用介面的前提條件及使用後造成的影響後，再進行操作。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    rds:ModifyParameter

    update

    *DBInstance

    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    • rds:ResourceTag
    • rds:TLSVersion
    		 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    ClientToken

    string

    否

    用於保證請求的等冪性，防止重複提交請求。由用戶端產生該參數值，要保證在不同請求間唯一，最大值不超過 64 個 ASCII 字元，且該參數值中不能包含非 ASCII 字元。

    ETnLKlblzczshOTUbOCz****
    DBInstanceId

    string

    是

    執行個體 ID。

    rm-uf6wjk5****
    Parameters

    string

    否

    參數及其值的 JSON 串，參數的值都是字串類型。格式：{"參數名稱 1":"參數值 1","參數名稱 2":"參數值 2"...}。可調用 DescribeParameterTemplates 查詢參數名稱和參數值。

    說明

    傳入該參數，則無需傳入參數 ParameterGroupId。

    {"delayed_insert_timeout":"600","max_length_for_sort_data":"2048"}
    Forcerestart

    boolean

    否

    修改參數是否重啟資料庫，取值：

    • true：強制重啟（若修改的參數當中，有需要重啟的參數，則必須傳入 true，否則修改將不生效）。

    • false：不強制重啟。

    預設值：false。

    false
    ParameterGroupId

    string

    否

    參數模板 ID。

    說明

    • 傳入該參數，則無需傳入參數 Parameters。

    • 如果應用參數模板需要重啟執行個體，需要傳入參數 Forcerestart。

    rpg-****
    SwitchTimeMode

    string

    否

    修改參數的執行時間，取值：

    • Immediate：預設值，立即執行。

    • MaintainTime：執行個體可營運時間段內執行。可調用 ModifyDBInstanceMaintainTime 介面修改可營運時間段。

    • ScheduleTime：手動指定執行時間。傳入該值需要同時傳入 SwitchTime 參數。

    枚舉值：

    • ScheduleTime :

      手動指定執行時間。傳入該值需要同時傳入 SwitchTime 參數。

    • Immediate :

      立即執行。

    • MaintainTime :

      執行個體可營運時間段內執行。可調用 ModifyDBInstanceMaintainTime 介面修改可營運時間段。

    ScheduleTime
    SwitchTime

    string

    否

    指定修改參數的執行時間。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。

    說明

    該時間必須大於目前時間（執行調用的時間）。

    2022-05-06T09:24:00Z

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    返回參數詳情。

    RequestId

    string

    請求 ID。

    542BB8D6-4268-45CC-A557-B03EFD7AB30A

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "542BB8D6-4268-45CC-A557-B03EFD7AB30A"
}

    異常返回樣本

    JSON格式

    {
    "RequestId": "7463B73D-35CC-4D19-A010-6B8D65D242EF",
    "HostId": "rds.aliyuncs.com",
    "Code": "UnsupportedOperation",
    "Message": "The specified action is not supported."
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 PendingActionOverdue the action execution time is already overdue 選擇的執行時間已到期
    400 EngineMigration.ActionDisabled Specified action is disabled while custins is in engine migration. 執行個體在引擎遷移中時，指定的操作被禁用。
    400 %s The following parameters are prohibited:
    %s
    400 Invalid.ParamGroupDBCategory ParamGroup category is basic, not standard. 參數組類別是基本的，而不是標準的。
    400 InvalidEffectiveTime.SpecialTimeIsNull SpecialTime is not valid. SpecialTime無效。
    400 InvalidParameters.Format Specified parameters is not valid. 無效的參數。
    400 StorageEngine.NotSupported Current instance storage engine dose not support this operation. 當前執行個體的儲存引擎不支援該操作。
    400 InvalideStatus.Format The instance status does not support this operation. 執行個體狀態不支援此操作。
    400 SystemParamGroupCode.Format Specific DBParamGroupId is not valid. 建立參數 DBParamGroupId 無效。
    400 Database.ConnectError Database connect error. please check instance status and database processlist 資料庫連接異常，請檢查執行個體狀態及資料庫的串連池
    400 InvalidInstanceParameter Specified name for the instance parameter is not valid. 執行個體參數指定的名稱無效。
    400 GroupReplicationNotSupport.InvalidParameters Group Replication limits parameters and does not support modification. Group Replication 對參數有限制，不支援修改。
    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 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 InvalidReleasedKeepPolicy.Format Specified Released Keep Policy is not valid. 執行個體釋放後的歸檔備份保留原則無效。
    400 InvalidDBInstanceEngineType.Format the DB instance engine type does not support this operation. DB執行個體引擎類型不支援此操作。
    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 OperationDenied.XengineSwitch Current custins can not turn off xengine param. 當前執行個體存在 xengine 表，無法切換到其他參數模板。
    400 InvalidParameterValue.Limit Parameter value exceeds limit. 參數值超過限制。
    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 IncorrectDBInstanceType The current database instance type does not support the operation. 當前資料庫執行個體類型不支援此操作。
    403 IncorrectDBInstanceState The current database status does not support the operation. 操作失敗，該執行個體狀態下不支援此操作。
    403 ParamNotSupportedForCurrentVersion Parameter is not supported for current version.
    403 Invalid.Parameter Specified parameters is not valid. 指定的參數無效。
    403 IncorrectEffectiveTime The specified EffectiveTime params is not valid. EffectiveTime參數無效。
    403 GroupReplicationNotSupport.InvalidEngineVersion Group Replication requires the instance engine version to be 8.0. 執行個體資料庫版本不是MySQL 8.0，不支援組複製。
    403 GroupReplicationNotSupport.InvalidNodeClassCode Group Replication requires the ClassCode of each node to be consistent. 執行個體各節點間規格不一致，不支援組複製。
    403 GroupReplicationNotSupport.InvalidNodeNum Group Replication is not supported, the number of nodes must be an odd number greater than or equal to 3. 執行個體節點個數不是大於等於3的單數，不支援組複製。
    403 GroupReplicationNotSupport.InvalidXengine Group Replication is not supported because the instance has xengine tables. 執行個體存在xengine引擎表，不支援組複製。
    403 GroupReplicationNotSupport.MemoryTooSmall Group Replication is not supported because the memory is too small. 執行個體規格記憶體太小，不支援組複製。
    403 IncorrectMinorVersion Current engine minor version does not support operations. 當前引擎小版本不支援此操作。
    403 GroupReplicationNotSupport.TableWithoutPrimaryKey Group Replication is not supported because the instance exists table has no primary key. 執行個體存在無主鍵的表，不支援組複製。
    403 IncorrectDBInstance The current DB instance 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 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 InvalidDBInstance.NotFound The specified instance does not exist or is not supported. 沒有找到指定的執行個體，請檢查執行個體的正確性。
    404 InvalidParam Sepcified wal_level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica. 指定的wal_level參數無效。執行個體中有此參數，因此無法替換。
    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. 指定的主機資訊不存在。

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。