Enable transparent encryption for a tenant using ModifyTenantEncryption - ApsaraDB for OceanBase (Deprecated) - Alibaba Cloud - ApsaraDB for OceanBase (Deprecated)

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

oceanbase:ModifyTenantEncryption

update

*All Resource

*

None

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. Valid values: INTERNAL : INTERNAL USER_KMS : USER_KMS	INTERNAL
EncryptionKeyId	string	No	The ID of the key.	key-shh322**470h8v0-g2ll85**

Response elements

Element	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. Valid values: INTERNAL : INTERNAL USER_KMS : USER_KMS	INTERNAL

Examples

Success response

JSON format

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

Error codes

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.