MongoDB データの保存時暗号化のための TDE 有効化 - MongoDB - Alibaba Cloud - ApsaraDB for MongoDB

操作説明

TDE (透過的データ暗号化) は、データファイルに対してリアルタイム I/O 暗号化および復号を実行します。データはディスクに書き込まれる前に暗号化され、ディスクからメモリへの読み取り時に復号されます。詳細については、「TDE (透過的データ暗号化) の設定」を参照してください。

説明

TDE (透過的データ暗号化) は一度有効にすると無効にできません。

この操作の呼び出し時には、インスタンスは以下の要件を満たしている必要があります。

インスタンスがレプリカセットインスタンスまたはシャードクラスターインスタンスであること。
インスタンスのストレージエンジンが WiredTiger であること。
インスタンスのストレージタイプがローカルディスクであること。
インスタンスのデータベースバージョンが 4.0 または 4.2 であること。データベースバージョンが 4.0 より前の場合は、 UpgradeDBInstanceEngineVersion 操作を呼び出してデータベースバージョンをスペックアップできます。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dds:ModifyDBInstanceTDE

update

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBInstanceId	string	必須	インスタンスの ID。	dds-bpxxxxxxxx
TDEStatus	string	必須	TDE ステータス。有効な値: enabled (TDE が有効であることを示します)。説明 TDE は一度有効にすると無効にできません。慎重に操作してください。	enabled
EncryptorName	string	任意	暗号化メソッド。有効な値: aes-256-cbc。説明このパラメーターは、TDEStatus パラメーターが enabled にセットされている場合にのみ使用できます。	aes-256-cbc
EncryptionKey	string	任意	カスタムキーの ID。カスタムキーは、以下のリージョンでのみサポートされています。その他のリージョンでは、暗号化にデフォルトキーが使用されます。シンガポール (ap-southeast-1) 杭州 (cn-hangzhou) 上海 (cn-shanghai) 北京 (cn-beijing) 深セン (cn-shenzhen) 中国 (香港) (cn-hongkong) マレーシア (ap-southeast-3)	749c1df7-xxxx-xxxx-xxxx-xxxxxxxxxxxx
RoleARN	string	任意	指定されたロールの Amazon リソースネーム (ARN)。フォーマット: `acs:ram::$accountID:role/$roleName`。説明 `$accountID`: Alibaba Cloud アカウントの ID。Alibaba Cloud マネジメントコンソールにログインし、右上隅のプロフィール画像にポインターを合わせて [セキュリティ設定項目] をクリックすると、ID をビューできます。 `$roleName`: RAM ロールの名前。Resource Access Management (RAM) コンソールにログインし、左側のナビゲーションウィンドウで [RAM ロール] をクリックし、RAM ロール名リストを表示して名前をビューできます。	acs:ram::123456789012****:role/adminrole
SwitchMode	string	任意	MongoDB インスタンスの TDE (透過的データ暗号化) ステータスを変更する時間。有効な値: 0: 即時。 1: O&M ウィンドウ内。	0

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストの ID。	434D7127-6229-4355-BA50-7A3685A725DF

例

成功レスポンス

JSONJSON

{
  "RequestId": "434D7127-6229-4355-BA50-7A3685A725DF"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	UnsupportedDBTdeStatus	Specified DB TDEStatus does not support this operation.
403	UnsupportedEngine	Current DB Instance engine does not support this operation.
403	IncorrectCharacterType	Current DB instance CharacterType does not support this operation.
403	IncorrectEngineVersion	Current engine version does not support operations.
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.	現在のデータベースインスタンスのステータスはこの操作をサポートしていません。
403	IncorrectDBInstanceLockMode	Current DB instance lock mode does not support this operation.	現在のデータベースインスタンスのロックモードはこの操作をサポートしていません。
404	InvalidClusterKms	this cluster not kms service.
404	InvalidParam	Specified parameters is not valid.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。