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

Querying TDE Status of a DB Instance (RDS for SQL Server)

Function

This API is used to query the TDE status.

• 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.

URI

• URI format

  GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/tde-status

• 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

• Parameter description

  Table 2 Request header parameters

  Parameter	Mandatory	Type	Description
  X-Auth-Token	Yes	String	Specifies the user token. The user token is a response to the API used to obtain a user token.

• URI example

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

Response

• Normal response

  Table 3 Parameter description

  Name	Type	Description
  instance_id	String	Instance ID.
  tde_status	String	TDE status. Enumerated values: open: Enabled close: Disabled

• Example normal response

  {
  "instance_id":"3d39c18788b54a919bab633874c159dfin04",
  "tde_status":"open"
  }

• Abnormal Response

  For details, see Abnormal Request Results.

Status Code

• Normal

  200

• Abnormal

  For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: DB Instance Management