UpdateDBInstanceTDE - PolarDB

Enables Transparent Data Encryption (TDE) for a PolarDB-X instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	UpdateDBInstanceTDE	The operation that you want to perform. Set the value to UpdateDBInstanceTDE.
RegionId	String	Yes	cn-hangzhou	The region ID of the instance.
DBInstanceName	String	Yes	pxc-hzjasdyuoo	The ID of the instance.
TDEStatus	Integer	Yes	1	Enables TDE. Set the value to 1.
EncryptionKey	String	Yes	RkVBNURDMjAtNkQ4QS01OTc5LTk3QUEtRkM1NzU0N******	The custom key that is used to encrypt data. This parameter is required if you want to use a custom key. If you do not specify this parameter, the key that is automatically generated by the backend is used to encrypt data.
RoleArn	String	Yes	acs:ram::1406926****:role/aliyunrdsinstanceencryptiondefaultrole	The Alibaba Cloud Resource Name (ARN) of the Resource Access Management (RAM) role that you want to assign to your account. For more information, see RAM role overview.

Response parameters


Parameter	Type	Example	Description
RequestId	String	FEA5DC20-6D8A-5979-97AA-FC57546ADC20	The ID of the request.
Data	Object		The returned information.
TaskId	String	42292****	The ID of the backend task.

Examples

Sample requests

http(s)://[Endpoint]/?Action=UpdateDBInstanceTDE
&RegionId=cn-hangzhou
&DBInstanceName=pxc-hzjasdyuoo
&TDEStatus=1
&EncryptionKey=RkVBNURDMjAtNkQ4QS01OTc5LTk3QUEtRkM1NzU0Nk******
&RoleArn=acs:ram::1406926****:role/aliyunrdsinstanceencryptiondefaultrole
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<UpdateDBInstanceTDEResponse>
    <RequestId>FEA5DC20-6D8A-5979-97AA-FC57546ADC20</RequestId>
    <Data>
        <TaskId>42292****</TaskId>
    </Data>
</UpdateDBInstanceTDEResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "FEA5DC20-6D8A-5979-97AA-FC57546ADC20",
  "Data" : {
    "TaskId" : "42292****"
  }
}

Error codes


HttpCode	Error code	Error message	Description
403	IncorrectEngineVersion	The current engine version does not support the operation.	The error message returned because the engine version of the specified PolarDB-X instance does not support this operation.

For a list of error codes, visit the API Error Center.