As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
DescribeSnapshots
Retorna informações sobre captura de tela do cluster. Por padrão, DescribeSnapshots lista todos os seus instantâneos; opcionalmente, ele pode descrever um único instantâneo ou apenas os instantâneos associados a um determinado cluster.
Sintaxe da Solicitação
{
"ClusterName": "string",
"MaxResults": number,
"NextToken": "string",
"ShowDetail": boolean,
"SnapshotName": "string",
"Source": "string"
}Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte Parâmetros comuns.
A solicitação aceita os dados a seguir no formato JSON.
- ClusterName
-
Um identificador de cluster fornecido pelo usuário. Se esse parâmetro for especificado, somente os snapshots associados a esse cluster específico serão descritos.
Tipo: String
Obrigatório: Não
- MaxResults
-
O número máximo de registros a serem incluídos na resposta. Se existirem mais registros do que o MaxResults valor especificado, um token será incluído na resposta para que os resultados restantes possam ser recuperados.
Tipo: número inteiro
Obrigatório: não
- NextToken
-
Um argumento opcional a ser passado caso o número total de registros exceda o valor de MaxResults. Se o NextToken for retornado, haverá mais resultados disponíveis. O valor de nextToken é um token de paginação exclusivo para cada página. Faça a chamada novamente usando o token retornado para recuperar a próxima página. Mantenha todos os outros argumentos inalterados.
Tipo: String
Obrigatório: Não
- ShowDetail
-
Um valor booliano que, se verdadeiro, a configuração do fragmento é incluída na descrição do snapshot.
Tipo: booliano
Obrigatório: não
- SnapshotName
-
O nome fornecido pelo usuário de um snapshot. Se esse parâmetro for especificado, somente esse snapshot nomeado será descrito.
Tipo: String
Obrigatório: Não
- Source
-
Se definido como sistema, a saída mostra snapshots que foram criados automaticamente pelo MemoryDB. Se definido como usuário, a saída mostra snapshots que foram criados manualmente. Se omitida, a saída mostra os snapshots criados automática e manualmente.
Tipo: String
Obrigatório: Não
Sintaxe da Resposta
{
"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"
}
]
}Elementos de Resposta
Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.
Os dados a seguir são retornados no formato JSON pelo serviço.
- NextToken
-
Um argumento opcional a ser passado caso o número total de registros exceda o valor de MaxResults. Se o NextToken for retornado, haverá mais resultados disponíveis. O valor de nextToken é um token de paginação exclusivo para cada página. Faça a chamada novamente usando o token retornado para recuperar a próxima página. Mantenha todos os outros argumentos inalterados.
Tipo: string
- Snapshots
-
Uma lista de snapshots. Cada item na lista contém informações detalhadas sobre um snapshot.
Tipo: matriz de objetos Snapshot
Erros
Para obter informações sobre os erros comuns que são comuns em todas ações, consulte Erros comuns.
- InvalidParameterCombinationException
-
Código de status HTTP: 400
- InvalidParameterValueException
-
Código de status HTTP: 400
- ServiceLinkedRoleNotFoundFault
-
Código de status HTTP: 400
- SnapshotNotFoundFault
-
Código de Status HTTP: 400
Consulte Também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
