この API を呼び出して、MongoDB インスタンスの TDE ステータスを変更することができます。
透過的データ暗号化 (TDE) を使用して、データファイルに対してリアルタイムの I/O 暗号化および復号化を実行できます。 データはディスクに書き込まれる前に暗号化され、ディスクからメモリに読み込まれる前に復号化されます。 詳細については、「TDE の設定」をご参照ください。
注 TDE を有効にすると、無効にすることはできません。
この API を呼び出す前に、次の要件を満たしていることを確認してください。
- インスタンスは、レプリカセットまたはシャードクラスターインスタンスである必要があります。
- インスタンスのストレージエンジンは WiredTiger である必要があります。
- インスタンスのデータベースエンジンのバージョンは 4.0 である必要があります。 データベースエンジンのバージョンが 4.0 より前の場合、UpgradeDBInstanceEngineVersionを呼び出して、データベースエンジンをアップグレードしてください。
リクエストパラメーター
| パラメーター | データ型 | 必須項目 | 例 | 説明 |
|---|---|---|---|---|
| DBInstanceId | String | はい | dds-bpxxxxxxxx |
インスタンスの ID。 |
| TDEStatus | String | はい | enabled |
TDE ステータス。 値を [Enabled] に設定します。 注 TDE を有効にするときは注意してください。 TDE を有効にすると、無効にすることはできません。
|
| Action | String | いいえ | ModifyDBInstanceTDE |
実行する操作。 値を ModifyDBInstanceTDE に設定します。 |
| AccessKeyId | String | いいえ | LTAIgbTGpxxxxxx |
Alibaba Cloud から提供された AccessKey ID。 |
| EncryptorName | String | いいえ | AES-256-CBC |
暗号化方法。 値を aes-256-cbc に設定します。 注 このパラメーターは、 TEDStatus パラメーターを [enabled] に指定した場合にのみ有効です。
|
レスポンスパラメーター
| パラメーター | データ型 | 例 | 説明 |
|---|---|---|---|
| RequestId | String | 434D7127-6229-4355-BA50-7A3685A725DF |
リクエストの ID です。 |
例
リクエスト例
http(s)://mongodb.aliyuncs.com/? Action=ModifyDBInstanceTDE
&DBInstanceId=dds-bpxxxxxxxx
&TDEStatus=enabled
&<Common request parameters>
通常のレスポンス例
XML 形式
<ModifyDBInstanceTDEResponse>
<RequestId>434D7127-6229-4355-BA50-7A3685A725DF</RequestId>
</ModifyDBInstanceTDEResponse>JSON 形式
{
"RequestId":"434D7127-6229-4355-BA50-7A3685A725DF"
}エラーコード
| HTTP ステータスコード | エラーコード | エラーメッセージ | 説明 |
|---|---|---|---|
| 403 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | 現在のインスタンスのステータスで該当の操作がサポートされていない場合に返されるエラーメッセージ。 指定したパラメーターが正しいかどうかをご確認ください。 |
| 403 | IncorrectDBInstanceLockMode | Current DB instance lock mode does not support this operation. | インスタンスがロックされている場合に返されるエラーメッセージ。 |
エラーコードの詳細については、「API エラーセンター」 をご参照ください。