Docs

RDS for SQL Server

Data security

DescribeDBInstanceTDE - Query instance TDE status

Call the DescribeDBInstanceTDE API to query the TDE status of an instance.

Request description

Asynchronous request

Debugging

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

This section describes only the request parameters specific to this API and some common parameters. For more information, refer to Common parameters.

Action string required Example value: DescribeDBInstanceTDE

The operation to perform. The value is DescribeDBInstanceTDE.

Version stringrequired Example value: 2022-01-01

The API version is 2022-01-01.

InstanceId string required Example value: mssql-6474c9******

Instance ID.

Response parameters

This section describes only the response parameters specific to this API. For more information, refer to Return structure.

InstanceId string Example value: mssql-6474c9******

Instance ID.

TDEStatus string Example value: Enable

The TDE status of the instance.

Enable: The TDE status for the instance is enabled.

Disable: The TDE status for the instance is disabled.

TDEMode string Example value: MSSQL_Default

The TDE encryption certificate generation mode for the instance.

MSSQL_Default: An encryption certificate generated by SQL Server.

User_Default: A custom certificate uploaded by the user.

DBStatus object[] Example value: [ { "DBName": "test_db", "Enable": true } ]

Database encryption status.

DBName string Example value: db1

Database name.

Enable boolean Example value: true

Specifies whether to enable encryption. Possible values:

true: The database is encrypted.

false: The database is not encrypted.

Request example

POST /?Action=DescribeDBInstanceTDE&Version=2022-01-01 HTTP/1.1​
Content-Type: application/json​
Host: rds-mssql.volcengineapi.com​
X-Date: 20230131T101010Z​
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mssql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****​
​
{​
    "InstanceId":"mssql-6474c9******"​
}​

Response example

{​
    "ResponseMetadata": {​
        "RequestId": "20260520161758301C2BD41631F024CFF2-******",​
        "Action": "DescribeDBInstanceTDE",​
        "Version": "2022-01-01",​
        "Service": "rds_mssql",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "DBStatus": [​
            {​
                "DBName": "test_db",​
                "Enable": true​
            }​
        ],​
        "InstanceId": "mssql-7b62f0******",​
        "TDEMode": "MSSQL_Default",​
        "TDEStatus": "Enable"​
    }​
}​

Error code

The following table lists the business logic-related error codes for this API. For public error codes, see the Public error codes document.

Status code	Error code	Error message	Description
400	InvalidParameter	The specified parameter %s is not valid.	The value of Parameter {parameter1} is invalid.
404	InstanceNotFound	The specified instance does not exist.	Instance not found.

Last updated: 2026.05.29 14:36:24