DescribeTenantEncryption API Reference - ApsaraDB for OceanBase - Alibaba Cloud - ApsaraDB for OceanBase (Deprecated)

You can call this operation to query the encryption information of a tenant.

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:DescribeTenantEncryption

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the OceanBase cluster.	ob317v4uif****
TenantId	string	No	The ID of the tenant.	t4louaeei****
TenantName	string	No	The name of the tenant. It must start with a letter or an underscore (), and contain 2 to 20 characters, which can be uppercase letters, lowercase letters, digits, and underscores (). It cannot be set to sys.	forMySQLTenant
PageNumber	integer	No	The number of the page to return. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of rows to return on each page. Maximum value: 100. Default value: 10	10

Response elements

Element	Type	Description	Example
	object	The return result of the request.
RequestId	string	The ID of the request.	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
TotalCount	integer	The total number of entries returned. This parameter takes effect in a pagination query.	8
TenantEncryptions	array<object>	The scenarios supporting encryption.
	object	The information about scenarios supporting encryption.
TenantId	string	The ID of the tenant.	t4louaeei****
TenantMode	string	The compatible mode of the tenant. Valid values: Oracle MySQL	MySQL
TenantName	string	The name of the tenant.	forMySQLTenant
EnableEncryption	boolean	Indicates whether encryption is enabled. Valid values: true false	false
TenantStatus	string	The status of the tenant.	ONLINE
Status	string	The status of tenant encryption enablement.	OPEN
EncryptionType	string	The encryption type.	INTERNAL
EncryptionKeyId	string	The ID of the encryption key created by Key Management Service (KMS).	xxx

Examples

Success response

JSON format

{
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "TotalCount": 8,
  "TenantEncryptions": [
    {
      "TenantId": "t4louaeei****",
      "TenantMode": "MySQL",
      "TenantName": "forMySQLTenant",
      "EnableEncryption": false,
      "TenantStatus": "ONLINE",
      "Status": "OPEN",
      "EncryptionType": "INTERNAL",
      "EncryptionKeyId": "xxx"
    }
  ]
}

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.