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

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

DescribeGlobalClusters

返回有关 Amazon DocumentDB 全局集群的信息。此 API 支持分页。

注意

此操作仅适用于 Amazon DocumentDB 集群。

请求参数

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

Filters.Filter.N

筛选条件指定要描述的一个或多个全局数据库集群。

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

类型:Filter 对象数组

必需:否

GlobalClusterIdentifier

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

类型:字符串

长度限制:最小长度为 1。最大长度为 255。

模式:[A-Za-z][0-9A-Za-z-:._]*

必需:否

Marker

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

类型:字符串

必需:否

MaxRecords

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

类型:整数

必需:否

响应元素

服务返回以下元素。

GlobalClusters。 GlobalClusterMember.N

类型:GlobalCluster 对象数组

Marker

类型:字符串

错误

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

GlobalClusterNotFoundFault

GlobalClusterIdentifier 并不引用现有全局集群。

HTTP 状态代码:404

另请参阅

有关在特定语言的 Amazon SDK 中使用此 API 的更多信息,请参阅以下内容: