更新日志庫的加密配置。可以為日志庫創建加密配置、開啟或關閉日志加密功能。
接口說明
使用限制
配置數據加密時，您第一次選定加密機制后，后續您無法修改數據加密機制。也不支持修改加密算法和加密類型，您只能通過 enable 參數開啟或者關閉加密功能。 例如，您第一次選擇的是通過日志服務自帶的服務密鑰加密機制，后續您無法修改為通過用戶自帶密鑰（BYOK）加密方式。
創建加密配置
通過日志服務自帶的服務密鑰加密
無需額外操作，加密和密鑰管理完全由日志服務負責。 創建加密配置時需要傳入 enable 與 encryptType 參數。
通過用戶自帶密鑰（BYOK）加密
需要先創建 KMS 主密鑰，日志服務通過用戶提供的密鑰加密日志。 創建加密配置時，需要傳入 enable 、encryptType、userCmkInfo 參數。
開啟或者關閉日志加密
在您首次創建加密配置成功后，后續不再支持修改加密機制。但是可以通過 enable 參數來開啟或者關閉日志加密。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
請求語法
PUT /logstores/{logstore}/encryption HTTP/1.1
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| project | string | 是 | 日志項目。 | test-project |
| logstore | string | 是 | 日志庫。 | test-logstore |
| body | object | 否 | 請求結構體 | |
| enable | boolean | 是 | 是否開啟日志加密。 加密配置更新成功后，后續的加密配置更新請求只允許修改是否開啟日志加密，不允許修改 encryptType、userCmkInfo 參數。 | true |
| encryptType | string | 否 | 加密算法類型，支持 default、m4、sm4_ecb、sm4_cbc、sm4_gcm、aes_ecb、aes_cbc、aes_cfb、aes_ofb、aes_gcm。 | default |
| userCmkInfo | object | 否 | 可選，當通過用戶自帶密鑰（BYOK）加密時，請填寫此選項。當通過日志服務自帶的服務密鑰加密時，無需填寫此選項。 | |
| keyId | string | 否 | BYOK 的主密鑰 ID，可通過阿里云密鑰管理服務創建一個主密鑰，主密鑰地域需要與日志服務訪問接入點相同。 | f5136b95-2420-ab31-xxxxxxxxx |
| roleArn | string | 否 | RAM 角色的 ARN，格式為 acs:ram::12344***:role/xxxxx。使用 BYOK 加密需要先創建一個 RAM 角色，并授予給該角色 AliyunKMSReadOnlyAccess、AliyunKMSCryptoUserAccess 權限。同時授予此 API 訪問者該 RAM 角色的 PassRole 權限。 | acs:ram::12344***:role/xxxxx |
| regionId | string | 否 | 地域，例如 cn-hangzhou。 | cn-hangzhou |
返回參數
示例
正常返回示例
JSON格式
{}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 404 | ProjectNotExist | The Project does not exist: xxxx. | 日志項目不存在. |
| 404 | LogStoreNotExist | logstore xxxx does not exist. | 日志庫不存在。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-11-13 | 新增 OpenAPI | 查看變更詳情 |