全部產品
Search
文件中心

:ModifyDBClusterTDE - 開啟PolarDB TDE功能

更新時間:Dec 11, 2025

ModifyDBClusterTDE

介面說明

說明

調試

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

調試

授權資訊

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

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

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

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

polardb:ModifyDBClusterTDE

update

*DBCluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

請求參數

名稱

類型

必填

描述

樣本值

DBClusterId

string

叢集 ID。

pc-************

TDEStatus

string

修改 TDE 狀態。取值固定為 Enable

Enable

RoleArn

string

角色的全域資源描述符,用來指定具體角色。詳情請參見 RAM 角色概覽

acs:ram::1406926*****:role/aliyunrdsinstanceencryptiondefaultrole

EncryptionKey

string

自訂金鑰識別碼。

749c1df7-****-****-****-*********

EncryptNewTables

string

是否開啟自動加密所有建立的表。取值:

  • ON:開啟

  • OFF:關閉

說明

僅當資料庫引擎為 MySQL 相容時,該參數生效。

ON

EnableAutomaticRotation

string

是否允許執行個體 TDE 密鑰在檢測到 KMS 密鑰版本變更時,於輪轉周期後最近的營運時間進行自動輪轉。僅自訂密鑰支援該參數。

  • true:允許

  • false:不允許

說明

僅當資料庫引擎為 PostgreSQL 相容或 Oracle 文法相容時,支援該參數。

false

返回參數

名稱

類型

描述

樣本值

object

RequestId

string

請求 ID。

5F859238-2A36-4A8D-BD0F-732112******

樣本

正常返回樣本

JSON格式

{
  "RequestId": "5F859238-2A36-4A8D-BD0F-732112******"
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

400 InvalidTDEStatus.AlreadyEnabled TDE has already enabled in the this cluster. 操作失敗,此叢集已開通TDE。
400 InvalidDBType.Malformed The Specified DBType is not valid. 指定的資料庫類型無效.
400 InvalidTDEEnabledType.Malformed The specified parameter TDEStatus is not valid. 指定的參數TDEStatus無效
400 InvalidAutoTableTransparentEncryption.Malformed The specified AutoTableTransparentEncryption is not valid. 指定的參數AutoTableTransparentEncryption無效。
403 UnsupportedKmsService.NotEnabled KMS service is not enabled. 未啟用KMS服務。
403 OperationDenied.DBNodeType The operation is not permitted due to type of node. 操作失敗,節點類型不允許此操作。
403 IncorrectGdnState db instance %s status is not available:%s. 執行個體 %s 狀態是無用的:%s。
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 當前的記錄中不存在提供的DBClusterId。
404 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid. 指定的參數DBClusterId無效

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

變更歷史

更多資訊,參考變更詳情