全部產品
Search
文件中心

ApsaraDB for MongoDB:ModifyParameters - 修改MongoDB執行個體的參數

更新時間:Oct 15, 2025

修改MongoDB執行個體的參數。

介面說明

  • 調用本介面時,ApsaraDB for MongoDB 執行個體的狀態為運行中。

  • 如果修改的參數中包含需要重啟才會生效的參數,調用本介面後執行個體將自動重啟。您可以調用 DescribeParameterTemplates 介面查詢哪些參數修改後需要重啟執行個體才會生效。

調試

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

調試

授權資訊

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

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

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dds:ModifyParameters

update

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

請求參數

名稱

類型

必填

描述

樣本值

RegionId

string

地區 ID。您可以通過調用 DescribeRegions 介面查詢。

cn-hangzhou

DBInstanceId

string

執行個體 ID。

說明

當本參數傳入的是分區叢集執行個體 ID 時,還需要傳入 NodeId 參數。

dds-bp19f409d75****

NodeId

string

分區叢集執行個體中的 Mongos 節點 ID 或 Shard 節點 ID。

說明

當 DBInstanceId 參數傳入的是分區叢集執行個體 ID 時,本參數才可用。

d-bp1b7bb3bbe****

Parameters

string

需要修改的參數及參數值,格式為 JSON 串,例如:{"ParameterName1":"ParameterValue1","ParameterName2":"ParameterValue2"}。

說明

您可以通過調用 DescribeParameterTemplates 介面查詢預設的參數模板列表。

{"operationProfiling.mode":"all","operationProfiling.slowOpThresholdMs":"200"}

CharacterType

string

執行個體的角色類型,取值說明:

  • db:shard 角色。

  • cs:config server 角色。

  • mongos:mongos 角色。

db

SwitchMode

string

修改 MongoDB 執行個體參數的時間點,取值:

  • 0:立刻修改。

  • 1:在可營運時間內修改。

枚舉值:

  • 0 :

    0

  • 1 :

    1

0

返回參數

名稱

類型

描述

樣本值

object

返回資訊。

RequestId

string

請求 ID。

36923CC2-DDAB-4B48-A144-DA92C1E19537

樣本

正常返回樣本

JSON格式

{
  "RequestId": "36923CC2-DDAB-4B48-A144-DA92C1E19537"
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

400 InvalidParameters.Format Specified parameters is not valid. 輸入的參數無效。
400 InvalidParameterForInstanceVersion Parameter %s is not valid for instance's MinorVersion. 當前執行個體小版本不支援參數 %s,請嘗試升級小版本。
400 InvalidParameter The specified parameter %s is not valid. 參數 %s 非有效參數。
400 OplogSizeLowerThanInstanceStorage The oplogSizeMB parameter entered is less than 10% of the instance store size. 輸入的oplogSizeMB參數低於執行個體儲存大小的10%。

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

變更歷史

更多資訊,參考變更詳情