文档

DescribeDBInstanceTDE - 查询RDS实例透明数据加密TDE状态

更新时间:

该接口用于查询RDS实例的透明数据加密TDE的加密状态。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server

调试

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

授权信息

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

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

请求参数

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

实例 ID。可调用 DescribeDBInstances 获取。

rm-uf6wjk5****

返回参数

名称类型描述示例值
object

返回参数详情。

TDEStatusstring

实例级别的 TDE 状态,取值:

  • Enabled
  • Disabled
Enabled
RequestIdstring

请求 ID。

C816A4BF-A6EC-4722-95F9-2055859CCFD2
Databasesobject []

数据库级别的 TDE 状态列表。

说明 对于 SQL Server 2019 标准版和 SQL Server 企业版实例,可以在实例级别的 TDE 开启时,控制数据库级别的 TDE 开启或关闭。
DBNamestring

数据库名称。

test02
TDEStatusstring

数据库级别的 TDE 状态,取值:

  • Enabled
  • Disabled
Enabled
TDEModestring

实例级别的 TDE 加密的密钥方式,取值:

  • Aliyun_Generate_Key
  • Customer_Provided_Key
  • Unknown
Aliyun_Generate_Key

示例

正常返回示例

JSON格式

{
  "TDEStatus": "Enabled",
  "RequestId": "C816A4BF-A6EC-4722-95F9-2055859CCFD2",
  "Databases": {
    "Database": [
      {
        "DBName": "test02",
        "TDEStatus": "Enabled"
      }
    ]
  },
  "TDEMode": "Aliyun_Generate_Key"
}

错误码

HTTP status code错误码错误信息描述
400Connect.TimeoutService can not connect to instance temporarily.操作失败,服务暂时无法连接到实例,请稍后重试。
400SqlExcutionFailedFailed to connect to host: connection timed out.无法连接到主机:连接超时。
400DbossGeneralErrorThe instance is being created. Please wait.实例正在创建中,请稍等。
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.套餐实例不允许单独操作。
400Price.PricingPlanResultNotFoundPricing plan price result not found.定价计划价格结果没有找到。
400Order.NoRealNameAuthenticationYou have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。
403IncorrectDBInstanceTypeCurrent DB instance engine and type does not support operations.操作失败,当前数据库实例引擎和类型不支持。
403IncorrectEngineVersionThe engine version does not support the operation.操作失败,当前数据库版本不支持该操作。
403DBSizeExceededExceeding the allowed DB size of DB instance.数据库大小超超限制。
404InvalidDBName.NotFoundSpecified one or more DB name does not exist or DB status does not support.操作失败,数据库实例名称不存在。

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

变更历史

变更时间变更内容概要操作
2023-08-31OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
出参OpenAPI 返回结构发生变更
2022-10-28OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    新增错误码:403
    新增错误码:404
2022-06-23OpenAPI 描述信息更新、OpenAPI 错误码发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400
2021-10-19OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
  • 本页导读 (1)
文档反馈