

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

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

返回有关预置的 Amazon DocumentDB 实例的信息。此 API 支持分页。

## 请求参数
<a name="API_DescribeDBInstances_RequestParameters"></a>

 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。

 ** DBInstanceIdentifier **   
用户提供的实例标识符。如果指定了此参数，则只返回特定实例的信息。该参数不区分大小写。  
约束：  
+ 如果提供，必须与现有 `DBInstance` 的标识符匹配。
类型：字符串  
必需：否

 **Filters.Filter.N**   
筛选条件指定要描述的一个或多个实例。  
支持的筛选条件：  
+  `db-cluster-id`-接受集群标识符和集群 Amazon 资源名称 (ARNs)。结果列表仅包含与由这些集群标识的集群关联的实例的相关信息 ARNs。
+  `db-instance-id`-接受实例标识符和实例 ARNs。结果列表仅包含有关由这些实例标识的实例的信息 ARNs。
类型：[Filter](API_Filter.md) 对象数组  
必需：否

 ** Marker **   
由之前的请求提供的可选分页标记。如果指定此参数，则响应仅包含标记之外的记录，最大数量为 `MaxRecords` 指定的值。  
类型：字符串  
必需：否

 ** MaxRecords **   
 包括在响应中的最大记录数。如果存在的记录数超过了指定的`MaxRecords` 值，则在响应中包含分页记号（标记），以便检索剩余的结果。  
默认值：100  
约束：最低为 20，最高为 100。  
类型：整数  
必需：否

## 响应元素
<a name="API_DescribeDBInstances_ResponseElements"></a>

服务返回以下元素。

 **DBInstances。 DBInstance.N**   
有关一个或多个实例的详细信息。  
类型：[DBInstance](API_DBInstance.md) 对象数组

 ** Marker **   
由之前的请求提供的可选分页标记。如果指定此参数，则响应仅包含标记之外的记录，最大数量为 `MaxRecords` 指定的值。  
类型：字符串

## 错误
<a name="API_DescribeDBInstances_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` 并不引用现有实例。  
HTTP 状态代码：404

## 另请参阅
<a name="API_DescribeDBInstances_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBInstances) 