Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Instance Management/ Enabling Transparent Data Encryption
Updated on 2025-10-20 GMT+08:00
View PDF
Share

Enabling Transparent Data Encryption

Function

This API is used to enable transparent data encryption (TDE) for an instance. Before calling this API:

Debugging

You can debug this API in API Explorer.

Constraints

The instance version must be V2.0-3.300 or later.

URI

PUT /v3/{project_id}/instances/{instance_id}/kms-tde/switch

Table 1 Parameter description

Parameter

Mandatory

Description

project_id

Yes

Definition

Project ID of a tenant in a region.

To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_id

Yes

Definition

Instance ID, which uniquely identifies an instance.

Constraints

N/A

Range

The value can contain 36 characters. Only letters and digits are allowed.

Default Value

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

kms_tde_key_id

Yes

String

Definition

ID of the KMS master key.

Constraints

N/A

Range

N/A

Default Value

N/A

kms_tde_status

Yes

String

Definition

Status of TDE.

Constraints

N/A

Range

on: It is enabled.

Default Value

N/A

kms_project_name

Yes

String

Definition

Name of a resource space, where you can view the ID of the KMS master key used by GaussDB for transparent data encryption.

To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Table 3 Parameter description

Parameter

Type

Description

job_id

String

Definition

Asynchronous job ID.

Range

N/A

Example Request

Enabling Transparent Data Encryption

PUT https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/d8e6ca5a624745bcb546a227aa3ae1cfin14/kms-tde/switch
{
    "kms_tde_key_id":"ca0da073-20a4-451d-812d-67f35d4d91f1",
    "kms_tde_status":"on",
    "kms_project_name":"kms_project_name"
}

Example Response

Transparent Data Encryption enabled.

{ 
   "job_id" : "bf26cf3c-d046-4080-bb45-f114be7afa5f" 
 }

Status Codes

Error Codes

For details, see Error Codes.

Parent topic: Instance Management