All Products
Search

This Product

    Tair (Redis® OSS-Compatible):ModifyInstanceTDE

    Document Center

    Tair (Redis® OSS-Compatible):ModifyInstanceTDE

    Last Updated:Aug 28, 2026

    Enables transparent data encryption (TDE) for a Tair (Redis OSS-compatible) instance. You can use existing custom keys.

    Operation description

    Note

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

    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

    kvstore:ModifyInstanceTDE

    update

    *DBInstance

    acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}
    • kvstore:TDEStatus
    		 None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    The ID of the instance. You can call the DescribeInstances operation to query the ID of the instance.

    r-bp1zxszhcgatnx****
    TDEStatus

    string

    Yes

    Specifies whether to enable TDE. Set the value to Enabled.

    Note

    TDE cannot be disabled after it is enabled. Before you enable it, evaluate whether this feature affects your business. For more information, see Enable TDE.

    Enabled
    EncryptionName

    string

    No

    The encryption algorithm. Default value: AES-CTR-256.

    Note

    This parameter is available only if the TDEStatus parameter is set to Enabled.

    AES-CTR-256
    EncryptionKey

    string

    No

    The ID of the custom key. You can call the DescribeEncryptionKeyList operation to query the key ID.

    Note

    ad463061-992d-4195-8a94-ed63********
    RoleArn

    string

    No

    The Alibaba Cloud Resource Name (ARN) of the Resource Access Management (RAM) role that you want to attach to your Tair (Redis OSS-compatible) instance. The ARN must be in the format of acs:ram::$accountID:role/$roleName. After the role is attached, your Tair (Redis OSS-compatible) instance can use KMS.

    Note

    • $accountID: the ID of the Alibaba Cloud account. To view the account ID, log on to the Alibaba Cloud console, move the pointer over your profile picture in the upper-right corner of the page, and then click Security Settings.

    • $roleName: the name of the RAM role. Replace $roleName with AliyunRdsInstanceEncryptionDefaultRole.

    acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The ID of the request.

    5D622714-AEDD-4609-9167-F5DDD3D1****

    Examples

    Success response

    JSON format

    {
  "RequestId": "5D622714-AEDD-4609-9167-F5DDD3D1****"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidInstanceName.Malformed The Specified parameter InstanceName is not valid.
    400 TaskExists Specified task have existed.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.