本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
DescribeSnapshots
返回有关集群快照的信息。默认情况下,会 DescribeSnapshots 列出您的所有快照;它可以选择描述单个快照,也可以仅描述与特定集群关联的快照。
请求语法
{
"ClusterName": "string
",
"MaxResults": number
,
"NextToken": "string
",
"ShowDetail": boolean
,
"SnapshotName": "string
",
"Source": "string
"
}
请求参数
有关所有操作的通用参数的信息,请参阅通用参数。
该请求接受以下JSON格式的数据。
- ClusterName
-
用户提供的集群标识符。如果指定了此参数,则仅描述与该特定集群关联的快照。
类型:字符串
必需:否
- MaxResults
-
包括在响应中的最大记录数。如果存在的记录多于指定 MaxResults 值,则响应中会包含一个标记,以便可以检索剩余的结果。
类型:整数
必需:否
- NextToken
-
一个可选参数,用于在记录总数超过的值时传递 MaxResults。如果返回, nextToken 则有更多结果可用。的值 nextToken 是每个页面的唯一分页标记。使用返回的令牌再次调用以检索下一页。保留所有其他参数不变。
类型:字符串
必需:否
- ShowDetail
-
一个布尔值,如果为 true,则分片配置将包含在快照描述中。
类型:布尔值
必需:否
- SnapshotName
-
快照的用户提供名称。如果指定了此参数,则仅描述此命名的快照。
类型:字符串
必需:否
- Source
-
如果设置为 system,则输出将显示由 MemoryDB 自动创建的快照。如果设置为 user,则输出将显示手动创建的快照。如果省略,则输出将同时显示自动和手动创建的快照。
类型:字符串
必需:否
响应语法
{
"NextToken": "string",
"Snapshots": [
{
"ARN": "string",
"ClusterConfiguration": {
"Description": "string",
"Engine": "string",
"EngineVersion": "string",
"MaintenanceWindow": "string",
"MultiRegionClusterName": "string",
"MultiRegionParameterGroupName": "string",
"Name": "string",
"NodeType": "string",
"NumShards": number,
"ParameterGroupName": "string",
"Port": number,
"Shards": [
{
"Configuration": {
"ReplicaCount": number,
"Slots": "string"
},
"Name": "string",
"Size": "string",
"SnapshotCreationTime": number
}
],
"SnapshotRetentionLimit": number,
"SnapshotWindow": "string",
"SubnetGroupName": "string",
"TopicArn": "string",
"VpcId": "string"
},
"DataTiering": "string",
"KmsKeyId": "string",
"Name": "string",
"Source": "string",
"Status": "string"
}
]
}
响应元素
如果操作成功,服务将发回 HTTP 200 响应。
以下数据由服务以JSON格式返回。
错误
有关所有操作的常见错误的信息,请参阅常见错误。
- InvalidParameterCombinationException
-
HTTP状态码:400
- InvalidParameterValueException
-
HTTP状态码:400
- ServiceLinkedRoleNotFoundFault
-
HTTP状态码:400
- SnapshotNotFoundFault
-
HTTP状态码:400
另请参阅
有关API在一种特定语言中使用此功能的更多信息 AWS SDKs,请参阅以下内容: