為云數據庫 Tair(兼容 Redis)實例開啟透明數據加密TDE功能,支持自定義密鑰。
接口說明
說明
關于透明數據加密 TDE(Transparent Data Encryption)的詳細介紹及開啟后的影響,請參見開啟透明數據加密 TDE。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
kvstore:ModifyInstanceTDE | update | *DBInstance acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId} |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 實例 ID,可調用 DescribeInstances 獲取。 | r-bp1zxszhcgatnx**** |
TDEStatus | string | 是 | 開啟 TDE 功能,取值:Enabled。 說明
TDE 功能開啟后暫不支持關閉,開啟前請評估是否影響業務。更多信息,請參見開啟透明數據加密 TDE。
| Enabled |
EncryptionName | string | 否 | 加密算法,默認 AES-CTR-256。 說明
當 TDEStatus 參數取值為 Enabled 時,本參數才可用。
| AES-CTR-256 |
EncryptionKey | string | 否 | 自定義密鑰 ID,您可以調用 DescribeEncryptionKeyList 獲取。 | ad463061-992d-4195-8a94-ed63******** |
RoleArn | string | 否 | 指定待授權角色的全局資源描述符 ARN(Alibaba Cloud Resource Name)信息,完成授權后即可使用相關密鑰管理服務,格式: 說明
$accountID :云賬號 ID。您可以登錄阿里云控制臺,將鼠標懸停在右上角頭像的位置,單擊安全設置進行查看。$roleName :RAM 角色名稱,取值固定為:AliyunRdsInstanceEncryptionDefaultRole。 | acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "5D622714-AEDD-4609-9167-F5DDD3D1****"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 |
---|---|---|
400 | InvalidInstanceName.Malformed | The Specified parameter InstanceName is not valid. |
400 | TaskExists | Specified task have existed. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2023-09-14 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-03-02 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |