DescribeTenantEncryption - ApsaraDB for OceanBase - Alibaba Cloud Documentation Center

You can call this operation to query the encryption information of 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

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
oceanbase:DescribeTenantEncryption	get	All Resources ``	none	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	long	No	The number of the page to return. Pages start from page 1. Default value: 1.	1
PageSize	long	No	The number of rows to return on each page. Maximum value: 100. Default value: 10	10

Response parameters

Parameter	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.
TenantEncryptions	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

Sample success responses

JSONformat

{
  "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
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