ListClusterSnapshots - Amazon DocumentDB
Sintaxe da SolicitaçãoParâmetros da Solicitação de URICorpo da SolicitaçãoSintaxe da RespostaElementos de RespostaErrosConsulte também

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á.

ListClusterSnapshots

Retorna informações sobre instantâneos para um cluster elástico específico.

Sintaxe da Solicitação

GET /cluster-snapshots?clusterArn=clusterArn&maxResults=maxResults&nextToken=nextToken&snapshotType=snapshotType HTTP/1.1

Parâmetros da Solicitação de URI

A solicitação usa os seguintes parâmetros de URI:

clusterArn

O identificador ARN do cluster elástico.

maxResults

O número máximo de resultados de instantâneos de cluster elástico a ser recebido na resposta.

Intervalo válido: valor mínimo de 20. Valor máximo de 100.

nextToken

Um token de paginação fornecido por uma solicitação anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além desse token, até o valor especificado por max-results.

Se não houver mais dados na resposta, nextToken não será retornado.

snapshotType

O tipo de snapshots de cluster a ser retornado. Você pode especificar um dos seguintes valores:

  • automated- Retorne todos os snapshots de cluster que o Amazon DocumentDB criou automaticamente para AWS sua conta.

  • manual- Retorne todos os instantâneos do cluster que você criou manualmente para sua AWS conta.

Corpo da Solicitação

Essa solicitação não tem corpo.

Sintaxe da Resposta

HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "snapshots": [ 
      { 
         "clusterArn": "string",
         "snapshotArn": "string",
         "snapshotCreationTime": "string",
         "snapshotName": "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 token de paginação fornecido por uma solicitação anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além desse token, até o valor especificado por max-results.

Se não houver mais dados na resposta, nextToken não será retornado.

Tipo: sequência

snapshots

Uma lista de instantâneos para um cluster elástico especificado.

Tipo: matriz de objetos ClusterSnapshotInList

Erros

Para obter informações sobre os erros comuns que todas as ações retornam, consulte Erros comuns.

AccessDeniedException

Uma exceção que ocorre quando não há permissões suficientes para realizar uma ação.

Código de Status HTTP: 403

InternalServerException

Ocorreu um erro interno no servidor.

Código de Status HTTP: 500

ThrottlingException

ThrottlingException será lançado quando a solicitação for negada devido à limitação da solicitação.

Código de Status HTTP: 429

ValidationException

Uma estrutura que define uma exceção de validação.

Código de Status HTTP: 400

Consulte também

Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos da linguagem, consulte o seguinte: