文档

ModifyDBInstanceTDE - 修改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:ModifyDBInstanceTDEWrite
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag
  • rds:TDEStatus

请求参数

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

实例 ID。可调用 DescribeDBInstances 获取。

rm-uf6wjk5****
TDEStatusstring

TDE 状态,取值:

  • Enabled
  • Disabled
Enabled
DBNamestring

想要开启 TDE 的数据库名称,可以一次输入多个,以英文逗号(,)分隔,最多传入 50 个。

说明 此参数仅 SQL Server 2019 标准版和 SQL Server 企业版实例可用(必传)。
testDB
EncryptionKeystring

自定义密钥 ID。

说明 仅 MySQL 或 PostgreSQL 实例可以传入此参数。
749c1df7-****-****-****-****
RoleArnstring

角色的全局资源描述符,用来指定具体角色。详情请参见 RAM 角色概览

说明 仅 MySQL 和 PostgreSQL 实例可以传入此参数。
acs:ram::1406926****:role/aliyunrdsinstanceencryptiondefaultrole
Certificatestring

证书文件。

格式:

  • 公网地址:oss-<地域 ID>.aliyuncs.com:<Bucket 名称>:<证书文件名称(带文件后缀)>
  • 内网地址:oss-<地域 ID>-internal.aliyuncs.com:<Bucket 名称>:<证书文件名称(带文件后缀)>
说明
  • 此参数仅 SQL Server 2019 标准版和 SQL Server 企业版实例可用。
  • 可以通过接口 DescribeRegions 查看可用的地域 ID。
  • oss-ap-southeast-1.aliyuncs.com:****:key.cer
    PrivateKeystring

    私钥文件。

    格式:

    • 公网地址:oss-<地域 ID>.aliyuncs.com:<Bucket 名称>:<私钥文件名称(带文件后缀)>
    • 内网地址:oss-<地域 ID>-internal.aliyuncs.com:<Bucket 名称>:<私钥文件名称(带文件后缀)>
    说明
  • 此参数仅 SQL Server 2019 标准版和 SQL Server 企业版实例可用。
  • 可以通过接口 DescribeRegions 查看可用的地域 ID。
  • oss-ap-southeast-1.aliyuncs.com:****:key.pvk
    PassWordstring

    证书密码。

    说明 此参数仅 SQL Server 2019 标准版和 SQL Server 企业版实例可用。
    1qaz@WSX
    IsRotateboolean

    是否更换密钥。 取值范围:

    • true:更换密钥
    • false:不更换密钥

    默认值:false

    说明 当前仅 RDS PostgreSQL 实例适用。
    false

    返回参数

    名称类型描述示例值
    object

    返回参数详情。

    RequestIdstring

    请求 ID。

    777C4593-8053-427B-99E2-105593277CAB

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "777C4593-8053-427B-99E2-105593277CAB"
    }

    错误码

    HTTP status code错误码错误信息描述
    400InvalidTDEstatusSpecified TDEStatus has already configed in the This instance.-
    400MissingDBNameThe request is missing a DBName parameter.-
    400InvalidTDEstatus.FormatThe Specified TDEStatus is not valid.无效的透明数据加密状态。
    400Invalid.PrivateKeyThe requested privateKey parameter is invalid.请求的私钥参数无效。
    400Invalid.CertificateThe requested certificate parameter is invalid.请求的证书参数无效。
    400CertOrPrivateKeyOrPasswordNotMatchedThe public certificate, private key, and password do not match.证书私钥密码不匹配。
    400InvalidTDEstatusSpecified TDEStatus is not configured on the This custins.-
    403IncorrectDBInstanceTypeCurrent DB instance type does not support this operation.操作失败,该实例状态下不支持此操作。
    403IncorrectEngineVersionCurrent engine version does not support operations.操作失败,当前数据库版本不支持此操作。
    403IncorrectDBInstanceLockModeCurrent DB instance lock mode does not support this operation.操作失败,实例处于锁定状态。
    403IncorrectDBInstanceStateCurrent DB instance state does not support this operation.当前实例状态不支持此操作。
    403DBSizeExceededExceeding the allowed DB size of DB instance.数据库大小超超限制。
    403IncorrectMinorVersionCurrent engine minor version does not support operations.当前引擎小版本不支持此操作。
    403ByokRoleArnNotFoundThe roleArn can not be null.-
    403InvalidKmsKeyKms key is disabled.Kms key已禁用。
    404InvalidClusterKmsthis cluster not kms service.-
    404InsufficientResourceCapacityThere is insufficient capacity available for the requested instance.-
    404InvalidDBName.NotFoundSpecified one or more DB name does not exist or DB status does not support.操作失败,数据库实例名称不存在。

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

    变更历史

    变更时间变更内容概要操作
    2023-09-08OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      错误码 403 变更
      删除错误码:400
      删除错误码:404
    2022-11-16OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      错误码 403 变更
      删除错误码:400
      删除错误码:404
    2022-11-16OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      错误码 403 变更
      删除错误码:400
      删除错误码:404
    入参OpenAPI 入参发生变更
      新增入参:IsRotate
    2022-06-23OpenAPI 描述信息更新、OpenAPI 错误码发生变更看变更集
    变更项变更内容
    API 描述OpenAPI 描述信息更新
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
      删除错误码:404
    • 本页导读 (1)
    文档反馈