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á.
ListClusters
Retorna informações sobre clusters elásticos Amazon DocumentDB provisionados.
Sintaxe da Solicitação
GET /clusters?maxResults=maxResults&nextToken=nextToken HTTP/1.1
Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
- maxResults
-
O número máximo de resultados de instantâneos de cluster elástico a ser recebido na resposta.
Faixa válida: valor mínimo de 1. 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,
nextTokennão será retornado.
Corpo da Solicitação
Essa solicitação não tem corpo.
Sintaxe da resposta
HTTP/1.1 200
Content-type: application/json
{
"clusters": [
{
"clusterArn": "string",
"clusterName": "string",
"status": "string"
}
],
"nextToken": "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.
- clusters
-
Uma lista de clusters elásticos do Amazon DocumentDB.
Tipo: matriz de objetos ClusterInList
- 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,
nextTokennão será retornado.Tipo: String
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:
