全部產品
Search

搜尋本產品

    ApsaraDB for MongoDB：ModifyDBInstanceSSL - 修改MongoDB執行個體的SSL鏈路配置

    文件中心

    ApsaraDB for MongoDB：ModifyDBInstanceSSL - 修改MongoDB執行個體的SSL鏈路配置

    更新時間：Jan 20, 2026

    修改MongoDB執行個體的SSL配置。

    介面說明

    調用 ModifyDBInstanceSSL 介面時，執行個體必須滿足以下條件：

    • 執行個體狀態為運行中。

    • 執行個體類型為複本集或分區叢集執行個體。

      • 複本集執行個體的版本需為 3.4 及以上版本。

      • 分區叢集執行個體的儲存模式需要為 ESSD 雲端硬碟版。

    說明

    在開通、更新和關閉 SSL 過程中，執行個體會重啟一次，建議您在業務低峰期操作。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    dds:ModifyDBInstanceSSL

    update

    *Instance

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

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    DBInstanceId

    string

    是

    執行個體 ID。

    dds-bp2235****
    SSLAction

    string

    是

    對 SSL 功能執行的操作，取值說明：

    • Open：開啟 SSL 加密。

    • Close：關閉 SSL 加密。

    • Update：更新 SSL 憑證。

    Open
    SwitchMode

    string

    否

    修改 MongoDB 執行個體 SSL 配置的時間點，取值：

    • 0：立刻修改。

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

    0
    ForceEncryption

    string

    否

    串連是否強制開啟 SSL 加密，取值說明：

    • 1：強制開啟 SSL 加密.

    • 0：不強制開啟 SSL 加密。

    說明

    • SSL 強制加密僅適用於雲端硬碟版 7.0 及 8.0 執行個體，且需滿足以下核心小版本要求：

      • 7.0 版本：核心小版本需為 8.0.13 及以上。

      • 8.0 版本：核心小版本需為 9.0.5 及以上。

    警告 啟用強制 SSL 加密後，將無法使用非 SSL 加密方式串連執行個體。

    枚舉值：

    • 0 :

      0

    • 1 :

      1

    0

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    返回資料。

    RequestId

    string

    請求 ID。

    6D806B11-078F-4154-BF9F-844F56D08964

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "6D806B11-078F-4154-BF9F-844F56D08964"
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 InvalidParam Specified parameters is not valid.
    400 SSLAlreadyEnabled SSL have already been enabled.
    400 SSLAlreadyDisabled SSL have already been disabled.
    403 SSLNotEnabled SSL not enabled.
    403 IncorrectCharacterType Current DB instance CharacterType does not support this operation.
    403 IncorrectEngineVersion Current engine version does not support operations.
    403 IncorrectDBInstanceState Current DB instance state does not support this operation. 當前資料庫執行個體狀態不支援此操作。
    403 IncorrectDBInstanceLockMode Current DB instance lock mode does not support this operation. 當前的資料庫執行個體鎖定模式不支援此操作。
    404 EnabledSSLNotSupport Specified region does not support enable ssl.

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

    變更歷史

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