All Products
Search
Document Center

ApsaraDB for Redis:ModifyInstanceTDE

Last Updated:May 28, 2024

Enables transparent data encryption (TDE) for an ApsaraDB for Redis instance. You can use existing custom keys.

Operation description

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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
kvstore:ModifyInstanceTDEWrite
  • DBInstance
    acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}
  • kvstore:TDEStatus
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

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

r-bp1zxszhcgatnx****
TDEStatusstringYes

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
EncryptionNamestringNo

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
EncryptionKeystringNo

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

Note
ad463061-992d-4195-8a94-ed63********
RoleArnstringNo

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 acs:ram::$accountID:role/$roleName. After the role is attached, your ApsaraDB for Redis 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 parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

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

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError message
400InvalidInstanceName.MalformedThe Specified parameter InstanceName is not valid.
400TaskExistsSpecified task have existed.

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

Change history

Change timeSummary of changesOperation
2023-09-14The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
2023-03-02The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400