ModifyTenantEncryption - 租户开启透明加密 - 云数据库 OceanBase

租户开启透明加密。

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
oceanbase:ModifyTenantEncryption	update	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	OceanBase 集群 ID。	ob317v4uif****
TenantId	string	是	租户 ID。	ob2mr3oae0****
EncryptionType	string	是	加密类型，返回值： NoEncryption：不启用加密。 CloudDisk：云盘加密并返回。 EncryptionKey：参数指定加密的密钥。说明云盘加密开启后无法关闭。枚举值： INTERNAL：INTERNAL。 USER_KMS：USER_KMS。	EncryptionKey
EncryptionKeyId	string	否	密钥 ID。	key-shh322**470h8v0-g2ll85**

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	Id of the request	EE205C00-30E4-**-**-87E3A8A2AA0C
TenantEncryption	object	job
InstanceId	string	OceanBase 集群 ID。	ob317v4uif****
TenantId	string	租户 ID。	ob2mr3oae0****
EncryptionType	string	加密类型，返回值： NoEncryption：不启用加密。 CloudDisk：云盘加密并返回。 EncryptionKey：参数指定加密的密钥。说明云盘加密开启后无法关闭。枚举值： INTERNAL：INTERNAL。 USER_KMS：USER_KMS。	EncryptionKey

示例

正常返回示例

JSON格式

{
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "TenantEncryption": {
    "InstanceId": "ob317v4uif****",
    "TenantId": "ob2mr3oae0****",
    "EncryptionType": "EncryptionKey"
  }
}

错误码

HTTP status code	错误码	错误信息	描述
500	InternalError	The request processing has failed due to some unknown error.	内部错误

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史