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

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. É possível especificar um dos seguintes valores:

  • automated – Retorna todos os snapshots de cluster que o Amazon DocumentDB criou automaticamente para sua conta da AWS.

  • manual - Retorna todos os snapshots de cluster que você criou manualmente para sua conta da AWS.

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: String

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 a todas ações, 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 do servidor.

Código de Status HTTP: 500

ThrottlingException

ThrottlingException será lançada 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 SDKs específicos de linguagem AWS, consulte: