この API では、MongoDB インスタンスの TDE をクエリします。
注 この関数の詳細については、「TDE の設定」をご参照ください。
この API を呼び出す場合、次の要件を満たしている必要があります。
- 対象のインスタンスは、レプリカセットまたはシャードクラスタインスタンスである必要があります。
- インスタンスのストレージエンジンは WiredTiger です。
- インスタンスのデータベースエンジンのバージョンは 4.0 です。 インスタンスのデータベースエンジンのバージョンが 4.0 以前の場合、UpgradeDBInstanceEngineVersionを実行して、データベースエンジンをアップグレードします。
リクエストパラメーター
パラメーター | データ型 | 必須項目 | 例 | 説明 |
---|---|---|---|---|
DBInstanceId | String | 必須 | dds-bpxxxxxxxx |
インスタンスの ID。 |
Action | String | 任意 | DescribeDBInstanceTDEInfo |
実行する操作。 値を DescribeDBInstanceTDEInfo に設定します。 |
AccessKeyId | String | 任意 | LTAIgbTGpxxxxxx |
Alibaba Cloud から提供された AccessKey ID。 |
レスポンスパラメーター
パラメーター | データ型 | 例 | 説明 |
---|---|---|---|
RequestId | String | F4DD0E29-361B-42F2-9301-B0048CCCE5D6 |
リクエストの ID。 |
TDEStatus | String | enabled |
TDE のステータス。 有効値:
|
コーディング例
リクエスト例
http(s)://mongodb.aliyuncs.com/? Action=DescribeDBInstanceTDEInfo
&DBInstanceId=dds-bpxxxxxxxx
&<Common request parameters>
通常のレスポンス例
XML
形式
<DescribeDBInstanceTDEInfoResponse>
<TDEStatus>enabled</TDEStatus>
<RequestId>F4DD0E29-361B-42F2-9301-B0048CCCE5D6</RequestId>
</DescribeDBInstanceTDEInfoResponse>
JSON
形式
{
"TDEStatus":"enabled",
"RequestId":"F4DD0E29-361B-42F2-9301-B0048CCCE5D6"
}
エラーコード
エラーコードの詳細については、API エラーセンター をご参照ください。