DescribeDBInstances - Amazon DocumentDB
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

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

DescribeDBInstances

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

请求参数

有关所有操作通用的参数的信息,请参阅常见参数.

DBInstanceIdentifier

用户提供的实例标识符。如果指定了此参数,则只返回特定实例的信息。该参数不区分大小写。

约束:

  • 如果提供,必须匹配现有的标识符DBInstance.

类型: 字符串

:必需 否

过滤器。过滤器。

筛选条件指定要描述的一个或多个实例。

支持的筛选条件:

  • db-cluster-id-接受集群标识符和集群 Amazon 资源名称 (ARN)。该结果列表仅包括与这些 ARN 所标识集群关联的实例的相关信息。

  • db-instance-id-接受实例标识符和实例 ARN。该结果列表仅包括由这些 ARN 标识的实例的相关信息。

类型: 数组Filter对象

:必需 否

Marker

由之前的请求提供的可选分页标记。如果指定此参数,则响应仅包含标记之外的记录,最大数量为 MaxRecords 指定的值。

类型: 字符串

:必需 否

MaxRecords

包括在响应中的最大记录数。如果存在的记录多于指定MaxRecords值,则在响应中包含分页记号(标记),以便检索剩余的结果。

默认值:100

约束:最低为 20,最高为 100。

类型: 整数

:必需 否

响应元素

服务返回以下元素。

dbInstances.dbinstance.n

有关一个或多个实例的详细信息。

类型: 数组DBInstance对象

Marker

由之前的请求提供的可选分页标记。如果指定此参数,则响应仅包含标记之外的记录,最大数量为 MaxRecords 指定的值。

类型: 字符串

Errors

有关所有操作中常见的错误的信息,请参阅常见错误.

DBInstanceNotFound

DBInstanceIdentifier不引用现有实例。

HTTP 状态代码:404

另请参阅

有关在特定语言的Amazon软件开发工具包中使用此 API 的更多信息,请参阅以下内容: