文档

ModifyTenantEncryption - 租户开启透明加密

更新时间:

租户开启透明加密。

调试

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

授权信息

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

请求参数

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

OceanBase 集群 ID。

ob317v4uif****
TenantIdstring

租户 ID。

ob2mr3oae0****
EncryptionTypestring

加密类型,返回值:

  • NoEncryption:不启用加密。
  • CloudDisk:云盘加密并返回。
  • EncryptionKey:参数指定加密的密钥。
说明
云盘加密开启后无法关闭。
枚举值:
  • INTERNALINTERNAL
  • USER_KMSUSER_KMS
EncryptionKey
EncryptionKeyIdstring

密钥 ID。

key-shh322****470h8v0-g2ll85****

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

EE205C00-30E4-****-****-87E3A8A2AA0C
TenantEncryptionobject

job

InstanceIdstring

OceanBase 集群 ID。

ob317v4uif****
TenantIdstring

租户 ID。

ob2mr3oae0****
EncryptionTypestring

加密类型,返回值:

  • NoEncryption:不启用加密。
  • CloudDisk:云盘加密并返回。
  • EncryptionKey:参数指定加密的密钥。
说明
云盘加密开启后无法关闭。
枚举值:
  • INTERNALINTERNAL
  • USER_KMSUSER_KMS
EncryptionKey

示例

正常返回示例

JSON格式

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

错误码

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

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

变更历史

变更时间变更内容概要操作
暂无变更历史