該介面用於開啟 RDS 執行個體的透明資料加密 TDE 功能，並支援修改加密狀態。
介面說明
適用引擎
RDS MySQL
RDS PostgreSQL
RDS SQL Server
相關功能文件
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| DBInstanceId |
string |
是 |
執行個體 ID。可呼叫 DescribeDBInstances 取得。 |
rm-uf6wjk5**** |
| TDEStatus |
string |
是 |
TDE 狀態，取值：
|
Enabled |
| DBName |
string |
否 |
想要開啟 TDE 的資料庫名稱，可以一次輸入多個，以英文逗號（,）分隔，最多傳入 50 個。 說明
此參數僅 SQL Server 2019 標準版、2022 標準版、2025 標準版和 SQL Server 企業版執行個體可用（必傳）。 |
testDB |
| EncryptionKey |
string |
否 |
自訂金鑰 ID。 說明
僅 MySQL 或 PostgreSQL 執行個體可以傳入此參數。 |
749c1df7-****-****-****-**** |
| RoleArn |
string |
否 |
角色的全域資源描述符，用來指定具體角色。詳情請參見 RAM 角色概覽。 說明
僅 MySQL 和 PostgreSQL 執行個體可以傳入此參數。 |
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 |
否 |
憑證密碼。 說明
此參數僅 SQL Server 2019 標準版、2022 標準版、2025 標準版和 SQL Server 企業版執行個體可用。 |
1qaz@WSX |
| IsRotate |
boolean |
否 |
是否更換金鑰。 取值範圍：
說明
目前僅 RDS PostgreSQL 執行個體適用。 |
false |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回參數詳情。 |
||
| RequestId |
string |
請求 ID。 |
777C4593-8053-427B-99E2-105593277CAB |
樣本
正常返回樣本
JSON格式
{
"RequestId": "777C4593-8053-427B-99E2-105593277CAB"
}錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | %s | DB Operation Failed:%s. | |
| 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 | InvalidTDEKey | Kms key is disabled. | Kms 金鑰已被停用。 |
| 400 | InvalidTDEStatus.NotFound | The specified TDEStatus does not exist. | 指定的 TDE 狀態不存在。 |
| 400 | PermissionDenied | The current account has not been authorized to allow RDS to access user's KMS services, authorization needs to be granted to this account. | 使用者目前帳號沒有授權 RDS 存取使用者的 KMS 服務，需要進行 KMS 授權，可參考授權 RDS 存取金鑰管理服務 KMS 文件進行授權。 |
| 400 | Order.ComboInstanceNotAllowOperate | A package instance is not allowed to operate independently. | 套件執行個體不允許單獨操作。 |
| 400 | Price.PricingPlanResultNotFound | Pricing plan price result not found. | 定價計畫價格結果沒有找到。 |
| 400 | Order.NoRealNameAuthentication | You 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. | 您尚未通過實名認證，不符合購買條件，請登入費用與成本進行實名認證。 |
| 400 | InsufficientAvailableQuota | Your account quota limit is less than 0, please recharge before trying to purchase. | 您的帳戶可用額度小於 0，請先儲值後再嘗試購買。 |
| 400 | CommodityServiceCalling.Exception | Failed to call commodity service. | 呼叫商品服務傳回失敗。 |
| 400 | RegionDissolvedEOM | Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support. | 使用者您好，阿里雲端計劃對當前地域進行最佳化調整，該區域雲端服務將停止營運，為確保您的業務連續性及資料移轉工作的平穩過渡，您目前無法操作新購類型的訂單，感謝理解與支援。 |
| 400 | Commodity.InvalidComponent | The module you purchased is not legal, please buy it again. | 您購買的模組不合法，請重新購買。 |
| 400 | RegionEndTimeDissolvedAustralia | Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024. | 使用者您好，該地域已裁撤。 |
| 400 | Price.CommoditySys | Commodity system call exception. | 商品系統呼叫異常。 |
| 400 | Pay.InsufficientBalance | Insufficient available balance. | |
| 400 | Order.PeriodInvalid | There is a problem with the period you selected, please choose again. | 您選購的週期有問題，請重新選購。 |
| 400 | pay.noCreditCard | Account not bound to credit card. | 無信用卡。 |
| 400 | Order.InstHasUnpaidOrder | There is an unpaid order for the service you have purchased. Please pay or void it before placing the order. | 您選購的服務存在未支付訂單，請支付或作廢後再下單。 |
| 400 | noAvailablePaymentMethod | No payment method is specified for your account. We recommend that you add a payment method. | 帳戶未指定付款方式。我們建議您新增付款方式。 |
| 400 | BasicInfoUncompleted | Your information is incomplete. Complete your information before the operation. | 您的基本資訊未完善，請在操作前先完善您的基本資訊。 |
| 400 | Risk.RiskControlRejection | Your account is abnormal, please contact customer service for details. | 您的帳戶出現異常，詳情請聯絡客服。 |
| 400 | Api.NotSupport | Specified api is not supported. | 目前介面不支援。 |
| 400 | ContainForbiddenLabelError | There is a label that prohibits placing orders. Please contact your distributor for assistance. | 存在禁止下單的標籤，請聯絡您的經銷商處理。 |
| 400 | InvalidDBInstanceId.NotFound | The DBInstanceId provided does not exist in records. | 提供的 DBInstanceId 不存在。 |
| 400 | InvalidInstanceLevel.DiskType | Specified instance level not support request disk type | 目前執行個體規格不支援該儲存類型。 |
| 400 | InvalidParam | Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica. | 輸入參數無效。 |
| 400 | KmsApiError | User secret key invalid. | 使用者金鑰失效。 |
| 400 | System.SaleValidateFailed | Sales expression validation system error. | |
| 400 | Abs.InvalidAccount.NotFound | account is not found. | 您的阿里雲端帳號不存在，或者您的 AccessKey 已經過期。 |
| 400 | SqlExecuteFailedOrTimeout | sql command execution failed or timed out:%s. | SQL 命令執行失敗或執行逾時。 |
| 400 | ColdData.EngineVersionNotSupport | The current instance engine version not support coldDataEnabled. | 目前執行個體引擎版本不支援歸檔冷資料。 |
| 400 | ColdData.MinorVersionNotSupport | The current instance minor version not support coldDataEnabled. | 目前核心版本不支援歸檔冷資料。 |
| 400 | IncorrectTargetClasscode | The current instance type does not support this operation. | 目前規格不支援此操作。 |
| 400 | InvalidConnectionString.Duplicate | Specified connection string already exists in the RDS. | 連結位址名稱重複，請重新設定連線字串。 |
| 400 | RequiredParam.NotFound | Required input param is not found. | 沒有傳入必要的參數。 |
| 400 | Parameters.Invalid | Parameter error, please check the parameters. | 參數錯誤，請檢查參數。 |
| 400 | BackupPolicyNotSupport | Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy. | 資料歸檔不支援跨地域備份和秒級快照，請檢查備份策略。 |
| 400 | InvalideStatus.Format | The instance status does not support this operation. | 執行個體狀態不支援此操作。 |
| 400 | InvalidReleasedKeepPolicy.Format | Specified Released Keep Policy is not valid. | 執行個體釋放後的歸檔備份保留策略無效。 |
| 400 | InvalidDBInstanceEngineType.Format | the DB instance engine type does not support this operation. | DB 執行個體引擎類型不支援此操作。 |
| 400 | Pay.NoCreditCard | No credit cards. | |
| 400 | VpcNetworkTypeNotSupport | The vpc network type instance does not support this operation. | VPC 網路類型執行個體不支援此操作。 |
| 400 | MirrorInsExists | Specified DB instance mirror ins already existed. | 目前資料庫執行個體映像已存在。 |
| 400 | UnsupportedClassCode | The specified DB instance class stops selling. | 執行個體規格已停止銷售。 |
| 400 | InvalidBackupSet | The specified database does not exist in the backup set. | 備份集中沒有指定的資料庫。 |
| 400 | OrdTCommodityQueryError | Failed to query for product. | 查詢產品失敗。 |
| 400 | ProductInstanceReleased | The instance has been released. Please check before placing the order. | 執行個體已釋放，請核實後下單。 |
| 400 | RegionEndTimeDissolvedIndia | The region is no longer supported. | 指定的地域無效。 |
| 400 | BYOKCertExpired | The certificate has exceeded the validity period. | 憑證已超過有效期。 |
| 500 | ExternalFailure | The request processing has failed due to external service failure. | 請求服務失敗，請稍後重試。 |
| 500 | RequestMetaDataFailed | The service request failed. Please try again later or contact service personnel. | 請求服務失敗，請稍後再試或聯絡服務人員。 |
| 500 | InvokeProxyFailure | The request processing has failed due to service failure of rds api. | 由於 RDS API 服務失敗，請求處理失敗。 |
| 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. | roleArn 不能為空。 |
| 403 | InvalidKmsKey | Kms key is disabled. | Kms key 已停用。 |
| 403 | OrderStatus.UnPaid | The specified db instance has unpaid order. | 執行個體當前存在未支付訂單，請支付後重試。 |
| 403 | InvalidReduceDiskSize | The storage capacity after the scale-down must be larger than the used amount. | 縮容目標容量不能小於目前儲存空間使用量。 |
| 403 | CloudSSDNotSupport | Cloud ssd does not support this operation, please upgrade to essd. | SSD 磁碟不支援此操作，請升級至 ESSD。 |
| 403 | InvalidUserOperatorPermission | The user permission does not support this operation. | 使用者權限不支援此操作。 |
| 403 | InvalidVswitchId | Specified conn vswitch id is not valid. | 指定的 VSwitchId 格式不正確或為空。 |
| 403 | OperationDenied.ZoneResource | There is no available zone for inventory. | 沒有可用的庫存區域。 |
| 403 | NotInFlowController | Sorry,no permission. | 非集團上雲使用者不可用，無權限。 |
| 403 | InvalidInstanceLevel.Malformed | Current DB instance level does not support this operation. | 目前資料庫執行個體層級不支援此操作。 |
| 403 | UnsupportedByBlueGreenDeployment | Operation prohibited due to blue green deployment. | 由於存在藍綠部署，因此不允許此操作。 |
| 403 | CrossBackupStrategyNotSupport | Cross region backup strategy is not supported. | 不支援跨地域備份策略。 |
| 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. | 操作失敗，資料庫執行個體名稱不存在。 |
| 404 | Request.NotFound | The requested resource is not available. | 請求的資源不可用。 |
| 404 | HostInfo.NotFound | The specified host info is not found. | 指定的主機資訊不存在。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。