文档中心

云数据库 SQL Server 版

数据安全

DescribeDBInstanceTDE - 查询实例 TDE 状态

调用 DescribeDBInstanceTDE 接口查询实例 TDE 状态。

请求说明

同步请求

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：DescribeDBInstanceTDE

要执行的操作，取值：DescribeDBInstanceTDE。

Version string 必选示例值：2022-01-01

API的版本，取值：2022-01-01。

InstanceId string 必选示例值：mssql-6474c9******

实例 ID。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

InstanceId string 示例值：mssql-6474c9******

实例 ID。

TDEStatus string 示例值：Enable

实例的 TDE 开启状态。

Enable：表示实例 TDE 状态为开启。

Disable：表示实例 TDE 状态为关闭。

TDEMode string 示例值：MSSQL_Default

实例的TDE加密证书生成模式。

MSSQL_Default: 由 SQL Server 生成的加密证书。

User_Default: 用户上传的自定义证书。

DBStatus object[] 示例值：[ { "DBName": "test_db", "Enable": true } ]

数据库加密状态。

DBName string 示例值：db1

数据库名称。

Enable boolean 示例值：true

是否开启加密。取值为：

true：数据库为加密状态。

false：数据库为解密状态。

请求示例

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******"​
}​

返回示例

{​
    "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"​
    }​
}​

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidParameter	The specified parameter %s is not valid.	参数 {parameter1} 值无效。
404	InstanceNotFound	The specified instance does not exist.	未找到该实例。

最近更新时间：2026.07.17 17:52:59

这个页面对您有帮助吗？

有用

无用