doc-exports/docs/rds/api-ref/rds_05_0081.html

Enabling TDE for a DB Instance (RDS for SQL Server)

Function

Transparent Data Encryption (TDE) performs real-time I/O encryption and decryption on data files. Data is encrypted before being written to disks and is decrypted when being read from disks to memory. This effectively protects the security of databases and data files. This API is used to enable TDE for a DB instance.

• Before calling an API, you need to understand the API in Authentication.
• Before calling this API, obtain the required region and endpoint.

Constraints

• This API supports only RDS for SQL Server instances.
• TDE cannot be disabled after being enabled, and it cannot be enabled again.
• The DB engine of the target instance must be of the Enterprise Edition, 2019 Standard Edition, or 2022 Standard Edition.

URI

• URI format

  PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/tde

• Parameter description

  Table 1 Parameter description

  Name	Mandatory	Description
  project_id	Yes	Specifies the project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID.
  instance_id	Yes	Instance ID.

Request

Table 2 Request header parameters

Parameter	Mandatory	Type	Description
Content-Type	Yes	String	The content type. The default value is application/json.
X-Auth-Token	Yes	String	Specifies the user token. The user token is a response to the API used to obtain a user token.

Example Request

Enable TDE for a DB instance.

PUT https://rds.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin04/tde

{}

Response

• Normal response

  Table 3 Parameter description

  Name	Type	Description
  job_id	String	Taskflow ID

• Example normal response

  {
  "job_id":"2b414788a6004883a02390e2eb0ea227"
  }

• Abnormal Response

  For details, see Abnormal Request Results.

Status Code

• Normal

  202

• Abnormal

  For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: DB Instance Management