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

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

DescribeDBClusters

返回有关预配置的 Amazon DocumentDB 集群的信息。此 API 操作支持分页。对于某些管理功能(如集群和实例周期管理),Amazon DocumentDB 利用与 Amazon RDS 和 Amazon Neptune 共享的操作技术。使用filterName=engine,Values=docdb筛选参数以仅返回 Amazon DocumentDB 集群。

请求参数

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

DBClusterIdentifier

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

约束:

  • 如果提供,则必须匹配现有DBClusterIdentifier.

类型: 字符串

:必填项:否

过滤器。过滤器。

筛选条件指定要描述的一个或多个集群。

支持的筛选条件:

  • db-cluster-id-接受集群标识符和集群 Amazon 资源名称 (ARN)。结果列表中仅包含由这些 ARN 确定的集群的相关信息。

类型: 数组Filter对象

:必填项:否

Marker

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

类型: 字符串

:必填项:否

MaxRecords

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

默认值:100

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

类型: 整数

:必填项:否

响应元素

服务返回以下元素。

dbclusters.dbCluster。

集群列表。

类型: 数组DBCluster对象

Marker

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

类型: 字符串

错误

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

DBClusterNotFoundFault

DBClusterIdentifier不引用现有集群。

HTTP 状态代码:404

另请参阅

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