ModifyTenantEncryption - ApsaraDB for OceanBase (Deprecated)

You can call this operation to enable transparent encryption for a tenant.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the OceanBase cluster.	ob317v4uif****
TenantId	string	Yes	The ID of the tenant.	ob2mr3oae0****
EncryptionType	string	Yes	The encryption type. Valid values: INTERNAL: a service key (automatically generated by the cloud service) USER_KMS: a custom key (Alibaba Cloud KMS) Note After transparent encryption is enabled for cloud disks, it cannot be disabled.	INTERNAL
EncryptionKeyId	string	No	The ID of the key.	key-shh322**470h8v0-g2ll85**

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	EE205C00-30E4-**-**-87E3A8A2AA0C
TenantEncryption	object	job
InstanceId	string	The ID of the OceanBase cluster.	ob317v4uif****
TenantId	string	The ID of the tenant.	ob2mr3oae0****
EncryptionType	string	The encryption type. Valid values: INTERNAL: a service key (automatically generated by the cloud service) USER_KMS: a custom key (Alibaba Cloud KMS) Note After transparent encryption is enabled for cloud disks, it cannot be disabled.	INTERNAL

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message
500	InternalError	The request processing has failed due to some unknown error.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history