

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# DescribeDBInstances
<a name="API_DescribeDBInstances"></a>

プロビジョニングされた Amazon DocumentDB インスタンスに関する情報を返します。この API はページ分割をサポートします。

## リクエストパラメーター
<a name="API_DescribeDBInstances_RequestParameters"></a>

 すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。

 ** DBInstanceIdentifier **   
ユーザーが指定したインスタンス識別子。このパラメータを指定した場合、特定のクラスターからの情報のみを返します。このパラメータでは大文字と小文字は区別されません。  
制約:  
+ 指定した場合、既存の `DBInstance` の識別子と一致する必要があります。
タイプ: 文字列  
必須: いいえ

 **Filters.Filter.N**   
記述する 1 つ以上のインスタンスを指定するフィルター。  
サポートされているフィルター:  
+  `db-cluster-id` - クラスター識別子とクラスターの Amazon リソースネーム (ARN) を受け入れます。結果リストには、これらの ARN で識別されるクラスターに関連付けられたインスタンスに関する情報のみが含まれます。
+  `db-instance-id` - インスタンス識別子とインスタンス ARN を受け入れます。結果リストには、これらの ARN で識別されるインスタンスに関する情報のみが含まれます。
タイプ: [Filter](API_Filter.md) オブジェクトの配列  
必須: いいえ

 ** Marker **   
以前のリクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。  
タイプ: 文字列  
必須: いいえ

 ** MaxRecords **   
 レスポンスに含めるレコードの最大数。指定された `MaxRecords` の値よりも多くのレコードが存在する場合、ページ割りトークン (マーカー) がレスポンスに含まれるため、残りの結果を取得できます。  
デフォルト: 100  
制約: 最小 20、最大 100。  
タイプ: 整数  
必須: いいえ

## レスポンス要素
<a name="API_DescribeDBInstances_ResponseElements"></a>

以下の要素がサービスによって返されます。

 **DBInstances.DBInstance.N**   
1 つ以上のインスタンスに関する詳細情報。  
型: [DBInstance](API_DBInstance.md) オブジェクトの配列

 ** Marker **   
以前のリクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。  
タイプ: 文字列

## エラー
<a name="API_DescribeDBInstances_Errors"></a>

すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` が既存の DB インスタンスを参照していません。  
HTTP ステータスコード: 404

## 以下の資料も参照してください。
<a name="API_DescribeDBInstances_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBInstances) 