更新日誌庫的加密配置。可以為日誌庫建立加密配置、開啟或關閉日誌加密功能。
介面說明
使用限制
配置資料加密時，您第一次選定加密機制後，後續您無法修改資料加密機制。也不支援修改密碼編譯演算法和加密類型，您只能通過 enable 參數開啟或者關閉加密功能。 例如，您第一次選擇的是通過Log Service內建的服務祕密金鑰加密機制，後續您無法修改為通過使用者內建密鑰（BYOK）加密方式。
建立加密配置
通過Log Service內建的服務祕密金鑰加密
無需額外操作，加密和密鑰管理完全由Log Service負責。 建立加密配置時需要傳入 enable 與 encryptType 參數。
通過使用者內建密鑰（BYOK）加密
需要先建立 KMS 主要金鑰，Log Service通過使用者提供的祕密金鑰加密日誌。 建立加密配置時，需要傳入 enable 、encryptType、userCmkInfo 參數。
開啟或者關閉日誌加密
在您首次建立加密配置成功後，後續不再支援修改加密機制。但是可以通過 enable 參數來開啟或者關閉日誌加密。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求文法
PUT /logstores/{logstore}/encryption HTTP/1.1路徑參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| logstore |
string |
是 |
日誌庫。 |
test-logstore |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| project |
string |
是 |
記錄項目。 |
test-project |
| 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）加密時，請填寫此選項。當通過Log Service內建的服務祕密金鑰加密時，無需填寫此選項。 |
|
| keyId |
string |
否 |
BYOK 的主要金鑰 ID，可通過阿里雲Key Management Service建立一個主要金鑰，主要金鑰地區需要與Log Service訪問存取點相同。 |
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 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
當前API暫無返回參數
樣本
正常返回樣本
JSON格式
{}錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 404 | ProjectNotExist | The Project does not exist: xxxx. | 記錄項目不存在. |
| 404 | LogStoreNotExist | logstore xxxx does not exist. | 日誌庫不存在。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。