All Products
Document Center

ApsaraDB for Redis:DescribeInstanceTDEStatus

Last Updated:Nov 03, 2023

Queries whether transparent data encryption (TDE) is enabled for an ApsaraDB for Redis instance.

Operation Description

For more information about TDE and the usage notes of TDE, see Enable TDE.

Note You can call the ModifyInstanceTDE to enable or disable TDE.


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.


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:
    • The required resource types are displayed in bold characters.
    • 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.
OperationAccess levelResource typeCondition keyAssociated operation
  • DBInstance

Request parameters


The ID of the ApsaraDB for Redis instance. You can call the DescribeInstances operation to query instance IDs.


Response parameters


Indicates whether TDE is enabled. Valid values:

  • Enabled: TDE is enabled.
  • Disable: TDE is disabled.

The ID of the request.



Sample success responses


  "TDEStatus": "Enabled",
  "RequestId": "5D622714-AEDD-4609-9167-F5DDD3D1****"

Error codes

HTTP status codeError codeError messageDescription
404InvalidInstanceId.NotFoundThe InstanceId provided does not exist in our records.The instance does not exist in the records. Call the DescribeInstances operation to query the instances that belong to the account.

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

Change history

Change timeSummary of changesOperation
2023-08-16The error codes of the API operation change.see changesets
Change itemChange content
Error CodesThe error codes of the API operation change.
    Added Error Codes: 404