DescribeUserEncryptionKeyList - MongoDB

操作説明

この操作によって返されるカスタムキーを使用して、TDE (透過的データ暗号化) を有効にできます。詳細については、「ModifyDBInstanceTDE」をご参照ください。

今すぐお試しください

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

get

*dbinstance

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBInstanceId	string	必須	インスタンス ID。	dds-bpxxxxxxxx
TargetRegionId	string	任意	ターゲットリージョンの ID。 DescribeRegions 操作を呼び出して、利用可能なリージョンをクエリできます。	cn-shanghai
RoleARN	string	任意	RAM ロールの Alibaba Cloud リソースネーム (ARN)。フォーマット： `acs:ram::$accountID:role/$roleName`。デフォルト値は `acs:ram::$accountID:role/aliyunrdsinstanceencryptiondefaultrole` です。説明 `$accountID`：ご利用の Alibaba Cloud アカウントの ID。 ID を表示するには、Alibaba Cloud 管理コンソールにログインし、右上隅にあるプロファイル写真にポインターを合わせ、[セキュリティ設定] をクリックします。 `$roleName`： RAM ロールの名前。ロール名を表示するには、RAM コンソールにログインします。左側のナビゲーションウィンドウで、[RAM ロール管理] をクリックします。 RAM ロール名リストでロール名を見つけます。	acs:ram::123456789012****:role/aliyunrdsinstanceencryptiondefaultrole

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	7CD51DA4-A499-43CE-B9B5-20CD4FDC648E
KeyIds	object
KeyId	array	インスタンスキーのリスト。
	string	インスタンスキー。	2a4f4ac2-xxxx-xxxx-xxxx-xxxxxxxxxxxx

例

成功レスポンス

JSONJSON

{
  "RequestId": "7CD51DA4-A499-43CE-B9B5-20CD4FDC648E",
  "KeyIds": {
    "KeyId": [
      "2a4f4ac2-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
403	INVALID_INSNAME_REGIONID_EMPTY	The insName and regionId can't be all empty

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

変更履歴

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