全部产品
Search
文档中心

日志服务:UpdateLogStoreEncryption - 更新加密配置

更新时间:Nov 28, 2024

更新日志库的加密配置。可以为日志库创建加密配置、开启或关闭日志加密功能。

接口说明

使用限制

配置数据加密时,您第一次选定加密机制后,后续您无法修改数据加密机制。也不支持修改加密算法和加密类型,您只能通过 enable 参数开启或者关闭加密功能。 例如,您第一次选择的是通过日志服务自带的服务密钥加密机制,后续您无法修改为通过用户自带密钥(BYOK)加密方式。

创建加密配置

通过日志服务自带的服务密钥加密

无需额外操作,加密和密钥管理完全由日志服务负责。 创建加密配置时需要传入 enable 与 encryptType 参数。

通过用户自带密钥(BYOK)加密

需要先创建 KMS 主密钥,日志服务通过用户提供的密钥加密日志。 创建加密配置时,需要传入 enable 、encryptType、userCmkInfo 参数。

开启或者关闭日志加密

在您首次创建加密配置成功后,后续不再支持修改加密机制。但是可以通过 enable 参数来开启或者关闭日志加密。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

PUT /logstores/{logstore}/encryption HTTP/1.1

请求参数

名称类型必填描述示例值
projectstring

日志项目。

test-project
logstorestring

日志库。

test-logstore
bodyobject

请求结构体

enableboolean

是否开启日志加密。 加密配置更新成功后,后续的加密配置更新请求只允许修改是否开启日志加密,不允许修改 encryptType、userCmkInfo 参数。

true
encryptTypestring

加密算法类型,支持 default、m4、sm4_ecb、sm4_cbc、sm4_gcm、aes_ecb、aes_cbc、aes_cfb、aes_ofb、aes_gcm。

default
userCmkInfoobject

可选,当通过用户自带密钥(BYOK)加密时,请填写此选项。当通过日志服务自带的服务密钥加密时,无需填写此选项。

keyIdstring

BYOK 的主密钥 ID,可通过阿里云密钥管理服务创建一个主密钥,主密钥地域需要与日志服务访问接入点相同。

f5136b95-2420-ab31-xxxxxxxxx
roleArnstring

RAM 角色的 ARN,格式为 acs:ram::12344***:role/xxxxx。使用 BYOK 加密需要先创建一个 RAM 角色,并授予给该角色 AliyunKMSReadOnlyAccess、AliyunKMSCryptoUserAccess 权限。同时授予此 API 访问者该 RAM 角色的 PassRole 权限。

acs:ram::12344***:role/xxxxx
regionIdstring

地域,例如 cn-hangzhou。

cn-hangzhou

返回参数

名称类型描述示例值
headersobject
Serverstring

服务器名称。

nginx
Content-Typestring

返回的响应体的内容格式。

application/json
Content-Lengthstring

响应内容长度。

0
Connectionstring

是否长链接。取值包括: close:不是长链接,则每个 HTTP 请求都会重新建立 TCP 连接。 keep-alive:长链接,TCP 连接建立后保持连接状态,节省连接所需时间和带宽。

close
Datestring

返回响应的时间。

Sun, 27 May 2018 08:25:04 GMT
x-log-requestidstring

服务端产生的标识,该请求的唯一 ID。

5B0A6B60BB6EE39764D458B5

示例

正常返回示例

JSON格式

{}

错误码

HTTP status code错误码错误信息描述
404ProjectNotExistThe Project does not exist: xxxx.日志项目不存在.
404LogStoreNotExistlogstore xxxx does not exist.日志库不存在。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-11-13新增 OpenAPI查看变更详情