修改MongoDB實例的參數(shù)。
接口說明
- 調(diào)用本接口時，云數(shù)據(jù)庫 MongoDB 實例的狀態(tài)為運行中。
- 如果修改的參數(shù)中包含需要重啟才能生效的參數(shù)，調(diào)用本接口后實例將自動重啟。您可以調(diào)用 DescribeParameterTemplates 接口查詢哪些參數(shù)修改后需要重啟實例才能生效。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調(diào)用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產(chǎn)品自身定義的條件關鍵字。
- 關聯(lián)操作：是指成功執(zhí)行操作所需要的其他權限。操作者必須同時具備關聯(lián)操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯(lián)操作 |
|---|---|---|---|---|
| dds:ModifyParameters | update |
|
| 無 |
請求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 否 | 地域 ID。您可以通過調(diào)用 DescribeRegions 接口查詢。 | cn-hangzhou |
| DBInstanceId | string | 是 | 實例 ID。 說明
當本參數(shù)傳入的是分片集群實例 ID 時，還需要傳入 NodeId 參數(shù)。
| dds-bp19f409d75**** |
| NodeId | string | 否 | 分片集群實例中的 Mongos 節(jié)點 ID 或 Shard 節(jié)點 ID。 說明
當 DBInstanceId 參數(shù)傳入的是分片集群實例 ID 時，本參數(shù)才可用。
| d-bp1b7bb3bbe**** |
| Parameters | string | 是 | 需要修改的參數(shù)及參數(shù)值，格式為 JSON 串，例如：{"ParameterName1":"ParameterValue1","ParameterName2":"ParameterValue2"}。 說明
您可以通過調(diào)用 DescribeParameterTemplates 接口查詢默認的參數(shù)模板列表。
| {"operationProfiling.mode":"all","operationProfiling.slowOpThresholdMs":"200"} |
| CharacterType | string | 否 | 實例的角色類型，取值說明：
| db |
返回參數(shù)
示例
正常返回示例
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. | 當前實例小版本不支持參數(shù) %s，請嘗試升級小版本。 |
| 400 | InvalidParameter | The specified parameter %s is not valid. | 參數(shù) %s 非有效參數(shù)。 |
| 400 | OplogSizeLowerThanInstanceStorage | The oplogSizeMB parameter entered is less than 10% of the instance store size. | 輸入的oplogSizeMB參數(shù)低于實例存儲大小的10%。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2024-08-27 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2024-07-23 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2024-06-25 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |