本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
ListClusterSnapshots
返回有关指定弹性集群的快照的信息。
请求语法
GET /cluster-snapshots?clusterArn=clusterArn
&maxResults=maxResults
&nextToken=nextToken
&snapshotType=snapshotType
HTTP/1.1
URI 请求参数
请求使用以下 URI 参数。
- clusterArn
-
弹性集群的 ARN 标识符。
- maxResults
-
在响应中接收的弹性集群快照结果的最大数量。
有效范围:最小值为 20。最大值为 100。
- nextToken
-
由之前的请求提供的分页标记。如果指定此参数,则响应仅包含该标记之外的记录,最大数量为
max-results
指定的值。如果响应中没有更多数据,则不会返回
nextToken
。 - snapshotType
-
要返回的集群快照的类型。可以指定以下值之一:
-
automated
- 返回 Amazon DocumentDB 已为您的 Amazon 账户自动创建的所有集群快照。 -
manual
- 返回您已为自身 Amazon 账户手动创建的所有集群快照。
-
请求正文
该请求没有请求正文。
响应语法
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"snapshots": [
{
"clusterArn": "string",
"snapshotArn": "string",
"snapshotCreationTime": "string",
"snapshotName": "string",
"status": "string"
}
]
}
响应元素
如果此操作成功,则该服务将会发送回 HTTP 200 响应。
服务以 JSON 格式返回以下数据。
- nextToken
-
由之前的请求提供的分页标记。如果指定此参数,则响应仅包含该标记之外的记录,最大数量为
max-results
指定的值。如果响应中没有更多数据,则不会返回
nextToken
。类型:字符串
- snapshots
-
指定弹性集群的快照列表。
类型:ClusterSnapshotInList 对象数组
错误
有关所有操作的常见错误的信息,请参阅常见错误。
- AccessDeniedException
-
没有足够权限执行某操作时出现的异常。
HTTP 状态代码:403
- InternalServerException
-
出现内部服务器错误。
HTTP 状态代码:500
- ThrottlingException
-
因请求节流拒绝请求时,将抛出 throttlingException。
HTTP 状态代码:429
- ValidationException
-
定义验证异常的结构。
HTTP 状态代码:400
另请参阅
有关在特定语言的 Amazon SDK 中使用此 API 的更多信息,请参阅以下内容: