ListClusters
Devuelve información sobre los clústeres elásticos de Amazon DocumentDB aprovisionados.
Sintaxis de la solicitud
GET /clusters?maxResults=maxResults&nextToken=nextToken HTTP/1.1
Parámetros de solicitud del URI
La solicitud utiliza los siguientes parámetros URI.
- maxResults
-
El número máximo de resultados de instantáneas de clúster elástico que se reciben en la respuesta.
Rango válido: valor mínimo de 1. Valor máximo de 100.
- nextToken
-
Un token de paginación proporcionado por una solicitud anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del token, hasta el valor especificado por
max-results.Si no hay más datos en la respuesta, no se devolverá el
nextToken.
Cuerpo de la solicitud
La solicitud no tiene un cuerpo de la solicitud.
Sintaxis de la respuesta
HTTP/1.1 200
Content-type: application/json
{
"clusters": [
{
"clusterArn": "string",
"clusterName": "string",
"status": "string"
}
],
"nextToken": "string"
}Elementos de respuesta
Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.
El servicio devuelve los datos siguientes en formato JSON.
- clusters
-
Lista de clústeres elásticos de Amazon DocumentDB.
Tipo: matriz de objetos ClusterInList
- nextToken
-
Un token de paginación proporcionado por una solicitud anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del token, hasta el valor especificado por
max-results.Si no hay más datos en la respuesta, no se devolverá el
nextToken.Tipo: cadena
Errores
Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores comunes.
- AccessDeniedException
-
Una excepción que se produce cuando no hay permisos suficientes para realizar una acción.
- message
-
Un mensaje de error que explica por qué se denegó el acceso.
Código de estado HTTP: 403
- InternalServerException
-
Se ha producido un error en el servidor interno.
Código de estado HTTP: 500
- ThrottlingException
-
Se lanzará ThrottlingException cuando se deniegue la solicitud debido a la limitación de la solicitud.
- retryAfterSeconds
-
La cantidad de segundos que se debe esperar para volver a intentar la operación.
Código de estado HTTP: 429
- ValidationException
-
Estructura que define una excepción de validación.
- fieldList
-
Una lista de los campos en los que se produjo la excepción de validación.
- message
-
Un mensaje de error que describe la excepción de validación.
- reason
-
El motivo por el que se produjo la excepción de validación (uno de los siguientes:
unknownOperation,cannotParse,fieldValidationFailedoother).
Código de estado HTTP: 400
Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
