翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
DescribeDBInstances
プロビジョニングされた Amazon DocumentDB インスタンスに関する情報を返します。この API はページ分割をサポートします。
リクエストパラメータ
すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。
- DBInstanceIdentifier
-
ユーザーが指定したインスタンス識別子。このパラメータを指定した場合、特定のクラスターからの情報のみを返します。このパラメータでは大文字と小文字は区別されません。
制約:
-
指定した場合、既存の
DBInstanceの識別子と一致する必要があります。
タイプ: 文字列
必須: いいえ
-
- Filters.Filter.N
-
記述する 1 つ以上のインスタンスを指定するフィルター。
サポートされているフィルター:
-
db-cluster-id- クラスター識別子とクラスターの Amazon リソースネーム (ARN) を受け入れます。結果リストには、これらの ARN で識別されるクラスターに関連付けられたインスタンスに関する情報のみが含まれます。 -
db-instance-id- インスタンス識別子とインスタンス ARN を受け入れます。結果リストには、これらの ARN で識別されるインスタンスに関する情報のみが含まれます。
型: Filter オブジェクトの配列
必須: いいえ
-
- Marker
-
以前のリクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには
MaxRecordsで指定された値まで、マーカーを超えるレコードのみが含まれます。タイプ: 文字列
必須: いいえ
- MaxRecords
-
レスポンスに含めるレコードの最大数。指定された
MaxRecordsの値よりも多くのレコードが存在する場合、ページ割りトークン (マーカー) がレスポンスに含まれるため、残りの結果を取得できます。デフォルト: 100
制約: 最小 20、最大 100。
タイプ: 整数
必須: いいえ
レスポンス要素
以下の要素がサービスによって返されます。
- DBInstances.DBInstance.N
-
1 つ以上のインスタンスに関する詳細情報。
型: DBInstance オブジェクトの配列
- Marker
-
以前のリクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには
MaxRecordsで指定された値まで、マーカーを超えるレコードのみが含まれます。型: 文字列
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- DBInstanceNotFound
-
DBInstanceIdentifierが既存の DB インスタンスを参照していません。HTTP ステータスコード: 404
その他の参照資料
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
