ModifyDBInstanceTDE操作を呼び出して、インスタンスの透過的データ暗号化 (TDE) を有効にすることができます。

TDEは、データファイルに対してリアルタイムのI/O暗号化と復号化を実行できます。 TDEは、データがディスクに書き込まれる前にデータを暗号化し、データがディスクから読み出されてメモリに書き込まれる前にデータを復号化する。 詳細については、「ApsaraDB RDS For MySQLインスタンスのTDEの設定」をご参照ください。

この API を呼び出す場合、インスタンスは次の要件を満たしている必要があります。

  • キー管理サービス (KMS) が有効化されています。 KMSがアクティブ化されていない場合、TDEを有効にするとKMSをアクティブ化できます。
  • インスタンスは、次のいずれかのデータベースエンジンバージョンとRDSエディションを実行する必要があります。
    • ローカルSSDを使用したRDS High-availability EditionでのMySQL 8.0 (マイナーエンジンバージョンの20191015以降)
    • ローカルSSDを使用したRDS High-availability EditionでのMySQL 5.7 (マイナーエンジンバージョンの20191015以降)
    • RDS MySQL 5.6
    • SQL Server 2019 SEまたはSQL ServerのEnterprise Edition
    • 20221030以降のマイナーエンジンバージョンを備えたPostgreSQL 10、PostgreSQL 11、PostgreSQL 12、PostgreSQL 13、またはPostgreSQL 14

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

項目データ型必須／任意例:説明
操作String必須ModifyDBInstanceTDE

実行する操作です。 値をModifyDBInstanceTDEに設定します。

DBInstanceIdString必須rm-uf6wjk5 ****

インスタンスの ID です。 DescribeDBInstancesを呼び出して、インスタンスのIDを照会できます。

TDEStatusString必須有効

TDEを有効にするかどうかを指定します。 有効な値：

  • 有効
  • 無効
DBNameString任意testDB

TDEを有効にするデータベースの名前。 1回のリクエストで最大50のデータベース名を指定できます。 複数のデータベース名を指定する場合は, コンマ (,) で区切ります。

説明 このパラメーターは、インスタンスがSQL Server 2019 SEまたはSQL ServerのEnterprise Editionを実行するときに使用でき、指定する必要があります。
暗号化キーString任意749c1df7-****-****-****-****

カスタムキーのID。

説明 このパラメーターは、インスタンスがMySQLまたはPostgreSQLを実行するときに使用できます。
RoleArnString任意acs:ram::1406926 ****:role/aliyunrdsinstanceencryptiondefaultrole

RAMロールのAlibaba Cloudリソース名 (ARN) 。 RAMロールは、Alibaba Cloudアカウント内で作成できる仮想IDです。 詳細については、「RAMロールの概要」をご参照ください。

説明 このパラメーターは、インスタンスがMySQLまたはPostgreSQLを実行するときに使用できます。
証明書String任意oss-ap-southeast-1.aliyuncs.com:****:key.cer

証明書を含むファイル。

形式

  • パブリックエンドポイント: oss-<regio n>.aliyuncs.comのID: <バケットの名前 >:< 証明書ファイルの名前> (ファイル名には拡張子が含まれています)
  • 内部エンドポイント: oss-<regio n>-internal.aliyuncs.comのID: <バケットの名前 >:< 証明書ファイルの名前> (ファイル名には拡張子が含まれています)
    説明
    • このパラメーターは、インスタンスがSQL Server 2019 SEまたはSQL ServerのEnterprise Editionを実行しているときに使用できます。
    • DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。
PrivateKeyString任意oss-ap-southeast-1.aliyuncs.com:****:key.pvk

証明書の秘密鍵を含むファイル。

形式

  • パブリックエンドポイント: oss-<regio n>.aliyuncs.comのID: <バケットの名前 >:< 秘密鍵を含むファイルの名前> (ファイル名には拡張子が含まれています)
  • 内部エンドポイント: oss-<regio n>-internal.aliyuncs.comのID: <バケットの名前 >:< 秘密鍵を含むファイルの名前> (ファイル名には拡張子が含まれています)
    説明
    • このパラメーターは、インスタンスがSQL Server 2019 SEまたはSQL ServerのEnterprise Editionを実行しているときに使用できます。
    • DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。
パスワードString任意1qaz @ WSX

証明書のパスワード。

説明 このパラメーターは、インスタンスがSQL Server 2019 SEまたはSQL ServerのEnterprise Editionを実行しているときに使用できます。
IsRotateBooleanいいえfalse

キーを置き換えるかどうかを指定します。

有効な値：

  • true: キーを置き換えます。
  • false: キーを置き換えません。

デフォルト値: "false"

説明 このパラメーターは、インスタンスがPostgreSQLを実行している場合にのみ使用できます。

レスポンスパラメーター

項目データ型例:説明
RequestIdString777C4593-8053-427B-99E2-105593277CAB

リクエストの ID です。

例

リクエストの例

http(s):// rds.aliyuncs.com/?Action=ModifyDBInstanceTDE
&DBInstanceId=rm-uf6wjk5 ****
&TDEStatus=有効
&<共通リクエストパラメーター>

正常に処理された場合のレスポンス例

XML 形式

HTTP/1.1 200 OK
Content-Type:application/xml

<ModifyDBInstanceTDEResponse>
    <RequestId>777C4593-8053-427B-99E2-105593277CAB</RequestId>
</ModifyDBInstanceTDEResponse>

JSON 形式

HTTP/1.1 200 OK
Content-Type:application/json

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

エラーコード

HTTP ステータスコードエラーコードエラーメッセージ説明
400InvalidTDEstatus. フォーマット指定されたTDEStatusは無効です。TDEStatusパラメーターの値が無効な場合に返されるエラーメッセージ。
400無効な. PrivateKey要求されたprivateKeyパラメーターが無効です。PrivateKeyパラメーターの値が無効な場合に返されるエラーメッセージ。
400無効な証明書要求された証明書パラメーターが無効です。Certificateパラメーターの値が無効な場合に返されるエラーメッセージ。
400CertOrPrivateKeyOrPasswordNotMatched公開証明書、秘密鍵、およびパスワードが一致しません。証明書、秘密鍵、およびパスワードが一致しない場合に返されるエラーメッセージ。
403IncorrectDBInstanceType現在のDBインスタンスタイプは、この操作をサポートしていません。インスタンスが現在の状態の場合、この操作がサポートされていない場合に返されるエラーメッセージ。
403IncorrectEngineVersion現在のエンジンバージョンは操作をサポートしていません。インスタンスで実行されているデータベースエンジンバージョンでは、この操作がサポートされていない場合に返されるエラーメッセージ。
403IncorrectDBInstanceLockMode現在のDBインスタンスロックモードはこの操作に対応していません。インスタンスがロックされている場合に返されるエラーメッセージ。
403IncorrectDBInstanceState現在のDBインスタンスの状態は、この操作をサポートしていません。インスタンスが現在の状態の場合、この操作がサポートされていない場合に返されるエラーメッセージ。
403DBSizeExceededDBインスタンスの許容DBサイズを超えています。指定されたデータベースのサイズが指定された制限を超えた場合に返されるエラーメッセージ。
403IncorrectMinorVersion現在のエンジンマイナーバージョンは操作をサポートしていません。この操作が現在のマイナーエンジンバージョンでサポートされていない場合に返されるエラーメッセージ。
404InvalidClusterKmsこのクラスターはkmsサービスではありません。KMSがアクティブ化されていない場合に返されるエラーメッセージ。
404InvalidDBName.NotFound指定された1つ以上のDB名が存在しないか、DB状態がサポートされていない。インスタンスの名前が見つからない場合に返されるエラーメッセージ。

エラーコードの一覧については、「サービスエラーコード」をご参照ください。