全部产品
Search
文档中心

:DescribeInstanceTDEStatus - 查询实例是否开启TDE加密

更新时间:Nov 06, 2024

查询云数据库 Tair(兼容 Redis)实例是否开启了TDE加密功能。

接口说明

关于透明数据加密 TDE(Transparent Data Encryption)的详细介绍及注意事项,请参见开启透明数据加密 TDE

说明 您可以调用 ModifyInstanceTDE 开启或关闭 TDE 加密功能。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
kvstore:DescribeInstanceTDEStatusget
  • 全部资源
    *

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID,可调用 DescribeInstances 获取。

r-bp1zxszhcgatnx****

返回参数

名称类型描述示例值
object
TDEStatusstring

TDE 加密功能是否开启,返回值:

  • Enabled:开启。
  • Disabled:关闭。
Enabled
RequestIdstring

请求 ID。

5D622714-AEDD-4609-9167-F5DDD3D1****

示例

正常返回示例

JSON格式

{
  "TDEStatus": "Enabled",
  "RequestId": "5D622714-AEDD-4609-9167-F5DDD3D1****"
}

错误码

HTTP status code错误码错误信息描述
404InvalidInstanceId.NotFoundThe InstanceId provided does not exist in our records.实例不存在我们的记录中,可调用DescribeInstances接口查看当前用户下的实例信息

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-08-16OpenAPI 错误码发生变更查看变更详情