Enables transparent data encryption (TDE) for a Tair (Redis OSS-compatible) instance. You can use existing custom keys.
Operation description
Debugging
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 Resourcesis 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 |
|---|---|---|---|---|
| kvstore:ModifyInstanceTDE | update | *DBInstance acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId} |
| 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 ApsaraDB for Redis instance. The ARN must be in the format of Note
| acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "5D622714-AEDD-4609-9167-F5DDD3D1****"
}Error codes
| HTTP status code | Error code | Error message |
|---|---|---|
| 400 | InvalidInstanceName.Malformed | The Specified parameter InstanceName is not valid. |
| 400 | TaskExists | Specified task have existed. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2023-09-14 | The Error code has changed | View Change Details |
| 2023-03-02 | The Error code has changed | View Change Details |