修改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 |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBInstanceId | string | 是 | 實例 ID。 | dds-bpxxxxxxxx |
TDEStatus | string | 是 | TDE 狀態,取值: enabled,即開啟 TDE 功能。 說明
TDE 功能開啟后不支持關閉,請謹慎開啟。
| enabled |
EncryptorName | string | 否 | 加密方式,取值:aes-256-cbc。 說明
當 TEDStatus 參數取值為 enabled 時,本參數才可用。
| aes-256-cbc |
EncryptionKey | string | 否 | 自定義密鑰 ID。 只有如下地域支持自定義密鑰,其余地域會使用默認密鑰加密。
| 749c1df7-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
RoleARN | string | 否 | 指定角色的 ARN。格式: 說明
$accountID :云賬號 ID。您可以通過登錄阿里云控制臺,將鼠標懸停在右上角頭像的位置,單擊安全設置進行查看。$roleName :RAM 角色名稱。您可以通過登錄 RAM 控制臺,單擊左側導航欄的 RAM 角色管理,在 RAM 角色名稱列表下進行查看。 | acs:ram::123456789012****:role/adminrole |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "434D7127-6229-4355-BA50-7A3685A725DF"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | UnsupportedDBTdeStatus | Specified DB TDEStatus does not support this operation. | 指定實例已開啟TDE,不支持此操作 |
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. | - |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|
暫無變更歷史