该接口用于开启RDS实例的透明数据加密TDE功能，并支持修改加密状态。
接口说明
适用引擎
- RDS MySQL
- RDS PostgreSQL
- RDS SQL Server
相关功能文档
注意 使用该接口前，请仔细阅读功能文档，确保完全了解使用接口的前提条件及使用后造成的影响后，再进行操作。
- RDS MySQL设置透明数据加密TDE
- RDS PostgreSQL设置透明数据加密TDE
- RDS SQL Server设置透明数据加密TDE
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI
Explorer可以自动生成SDK代码示例。
调试
调试
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| rds:ModifyDBInstanceTDE | Write |
|
|
无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBInstanceId | string | 是 |
实例ID。可调用DescribeDBInstances获取。 |
rm-uf6wjk5**** |
| TDEStatus | string | 是 |
TDE状态，取值：
|
Enabled |
| DBName | string | 否 |
想要开启TDE的数据库名称，可以一次输入多个，以英文逗号（,）分隔，最多传入50个。 说明 | testDB |
| EncryptionKey | string | 否 | 自定义密钥ID。 说明 | 749c1df7-****-****-****-**** |
| RoleArn | string | 否 | 角色的全局资源描述符，用来指定具体角色。详情请参见RAM角色概览。 说明 | acs:ram::1406926****:role/aliyunrdsinstanceencryptiondefaultrole |
| Certificate | string | 否 | 证书文件。 格式：
说明 |
oss-ap-southeast-1.aliyuncs.com:****:key.cer |
| PrivateKey | string | 否 |
私钥文件。 格式：
说明 |
oss-ap-southeast-1.aliyuncs.com:****:key.pvk |
| PassWord | string | 否 |
证书密码。 说明 | 1qaz@WSX |
| IsRotate | boolean | 否 | 是否更换密钥。
默认值：false 说明 | false |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| object | 返回参数详情。 |
||
| RequestId | string |
请求ID。 |
777C4593-8053-427B-99E2-105593277CAB |
示例
正常返回示例
JSON格式
{
"RequestId": "777C4593-8053-427B-99E2-105593277CAB"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidTDEstatus | Specified TDEStatus has already configed in the This instance. | – |
| 400 | MissingDBName | The request is missing a DBName parameter. | – |
| 400 | InvalidTDEstatus.Format | The Specified TDEStatus is not valid. | 无效的透明数据加密状态。 |
| 400 | Invalid.PrivateKey | The requested privateKey parameter is invalid. | 请求的私钥参数无效。 |
| 400 | Invalid.Certificate | The requested certificate parameter is invalid. | 请求的证书参数无效。 |
| 400 | CertOrPrivateKeyOrPasswordNotMatched | The public certificate, private key, and password do not match. | 证书私钥密码不匹配。 |
| 400 | InvalidTDEstatus | Specified TDEStatus is not configured on the This custins. | – |
| 403 | IncorrectDBInstanceType | Current DB instance type does not support this operation. | 操作失败，该实例状态下不支持此操作。 |
| 403 | IncorrectEngineVersion | Current engine version does not support operations. | 操作失败，当前数据库版本不支持此操作。 |
| 403 | IncorrectDBInstanceLockMode | Current DB instance lock mode does not support this operation. | 操作失败，实例处于锁定状态。 |
| 403 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | 当前实例状态不支持此操作。 |
| 403 | DBSizeExceeded | Exceeding the allowed DB size of DB instance. | 数据库大小超超限制。 |
| 403 | IncorrectMinorVersion | Current engine minor version does not support operations. | 当前引擎小版本不支持此操作。 |
| 403 | ByokRoleArnNotFound | The roleArn can not be null. | – |
| 403 | InvalidKmsKey | Kms key is disabled. | Kms key已禁用。 |
| 404 | InvalidClusterKms | this cluster not kms service. | – |
| 404 | InsufficientResourceCapacity | There is insufficient capacity available for the requested instance. | – |
| 404 | InvalidDBName.NotFound | Specified one or more DB name does not exist or DB status does not support. | 操作失败，数据库实例名称不存在。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2023-09-08 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||
|
||||||||||||||
| 2022-11-16 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||
|
||||||||||||||
| 2022-11-16 | OpenAPI 错误码发生变更，OpenAPI 入参发生变更 | 看变更集 | ||||||||||||
|
||||||||||||||
| 2022-06-23 | OpenAPI 描述信息更新，OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||
|
内容没看懂？ 不太想学习？想快速解决？ 有偿解决： 联系专家
阿里云企业补贴进行中： 马上申请
腾讯云限时活动1折起，即将结束： 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折，更有现金返利:同意关联，立享优惠
转转请注明出处：https://www.yunxiaoer.com/154886.html