全部產品
Search

搜尋本產品

    ApsaraDB for MongoDB：ModifyDBInstanceTDE - 修改MongoDB執行個體的透明資料加密TDE狀態

    文件中心

    ApsaraDB for MongoDB：ModifyDBInstanceTDE - 修改MongoDB執行個體的透明資料加密TDE狀態

    更新時間：Apr 21, 2026

    修改MongoDB執行個體的透明資料加密TDE（Transparent Data Encryption）狀態。

    介面說明

    透明資料加密 TDE（Transparent Data Encryption）可對資料檔案執行即時 I/O 加密和解密，資料在寫入磁碟之前進行加密，從磁碟讀入記憶體時進行解密，更多詳情請參見設定透明資料加密 TDE。

    說明

    TDE 功能開通後無法關閉。

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

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

    • 執行個體的儲存引擎為 WiredTiger。

    • 執行個體的儲存類型為本地碟版。

    • 執行個體的資料庫版本為 4.0 或 4.2 版本，如果執行個體資料庫版本過低，您可以調用 UpgradeDBInstanceEngineVersion 介面升級資料庫版本。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    dds:ModifyDBInstanceTDE

    update

    *Instance

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

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    DBInstanceId

    string

    是

    執行個體 ID。

    dds-bpxxxxxxxx
    TDEStatus

    string

    是

    TDE 狀態，取值： enabled，即開啟 TDE 功能。

    說明

    TDE 功能開啟後不支援關閉，請謹慎開啟。

    enabled
    EncryptorName

    string

    否

    加密方式，取值：aes-256-cbc。

    說明

    當 TEDStatus 參數取值為 enabled 時，本參數才可用。

    aes-256-cbc
    EncryptionKey

    string

    否

    自訂金鑰識別碼。 只有如下地區支援自訂密鑰，其餘地區會使用預設祕密金鑰加密。

    • 新加坡（ap-southeast-1）

    • 杭州（cn-hangzhou）

    • 上海（cn-shanghai）

    • 北京（cn-beijing）

    • 深圳（cn-shenzhen）

    • 香港（cn-hongkong）

    • 馬來西亞（ap-southeast-3）

    749c1df7-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    RoleARN

    string

    否

    指定角色的 ARN。格式：acs:ram::$accountID:role/$roleName 。

    說明

    • $accountID：雲帳號 ID。您可以通過登入阿里雲控制台，將滑鼠移至上方在右上方頭像的位置，單擊安全設定進行查看。

    • $roleName：RAM 角色名稱。您可以通過登入 RAM 控制台，單擊左側導覽列的 RAM 角色管理，在 RAM 角色名稱列表下進行查看。

    acs:ram::123456789012****:role/adminrole

    SwitchMode

    string

    否

    修改 MongoDB 執行個體透明資料加密（TDE）狀態時間點，取值：

    • 0：立刻修改。

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

    0

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID。

    434D7127-6229-4355-BA50-7A3685A725DF

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "434D7127-6229-4355-BA50-7A3685A725DF"
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 UnsupportedDBTdeStatus Specified DB TDEStatus does not support this operation.
    403 UnsupportedEngine Current DB Instance engine does not support this operation.
    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 InvalidClusterKms this cluster not kms service.
    404 InvalidParam Specified parameters is not valid.

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

    變更歷史

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