MongoDB の TDE 暗号化状態概要 - ApsaraDB for MongoDB - Alibaba Cloud - ApsaraDB for MongoDB

操作説明

説明

この特徴の詳細については、TDE (透過的データ暗号化) の設定項目を参照してください。

この操作を呼び出す場合、インスタンスは次の条件を満たす必要があります:

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

今すぐお試しください

この 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:DescribeDBInstanceTDEInfo

get

*Instance

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBInstanceId	string	必須	インスタンス ID。	dds-bpxxxxxxxx

レスポンスフィールド

フィールド	型	説明	例
	object
TDEStatus	string	TDE (透過的データ暗号化) の有効化ステータス。有効な値: enabled: TDE が有効です。 disabled: TDE が無効です。説明 TDE ステータスが disabled の場合、RoleARN、EncryptionKey、および EncryptorName パラメーターは返されません。	enabled
RequestId	string	リクエスト ID。	F4DD0E29-361B-42F2-9301-B0048CCCE5D6
RoleARN	string	権限付与待ちのロールのグローバルリソース記述子 Amazon リソースネーム (ARN) (Alibaba Cloud リソースネーム)。	acs:ram::123456789012****:role/aliyunrdsinstanceencryptiondefaultrole
EncryptionKey	string	インスタンスのカスタムキー。現在、Bring Your Own Key (BYOK) をサポートしているリージョンは以下のみです。BYOK を使用すると、暗号化キーを自分で管理および所有できます: 中国 (杭州) 中国 (上海) 中国 (北京) 中国 (深圳) 中国香港シンガポールマレーシア (クアラルンプール) 説明 BYOK がサポートされている場合、キーを自分で管理および所有でき、システムはカスタムキーを返します。BYOK がサポートされていない場合、キーを管理できず、システムは文字列 `NoActiveBYOK` を返します。	2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
EncryptorName	string	暗号化アルゴリズム。	aes-256-cbc

例

成功レスポンス

JSONJSON

{
  "TDEStatus": "enabled",
  "RequestId": "F4DD0E29-361B-42F2-9301-B0048CCCE5D6",
  "RoleARN": "acs:ram::123456789012****:role/aliyunrdsinstanceencryptiondefaultrole",
  "EncryptionKey": "2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "EncryptorName": "aes-256-cbc"
}

エラーコード

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

変更履歴

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