Devuelve los detalles de todos los clústeres en todos los proyectos a los que tienes acceso. Los clústeres contienen un grupo de hosts que mantienen el mismo conjunto de datos. La respuesta no incluye clústeres multi-nube. Para utilizar este recurso, la Cuenta de Servicio solicitante o la Clave de API puede tener cualquier rol a nivel de clúster.
Parámetros de query
-
Bandera que indica si la aplicación envuelve la respuesta en un objeto JSON
envelope. Algunos clientes de la API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para remediar esto, establece envelope=true en la query. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como un sobre. La aplicación agrega el parámetro de estado al cuerpo de la respuesta.El valor por defecto es
false. -
Bandera que indica si la respuesta devuelve el número total de elementos (
totalCount) en la respuesta.El valor por defecto es
true. -
Número de elementos que la respuesta retorna por página.
El valor mínimo es
1, el valor máximo es500. El valor predeterminado es100. -
Número de la página que muestra el conjunto actual del total de objetos que devuelve la respuesta.
El valor mínimo es
1. El valor por defecto es1. -
Bandera que indica si el cuerpo de la respuesta debe estar en el formato prettyprint.
El valor por defecto es
false.Impresión bonita
curl \
--request GET 'https://cloud.mongodb.com/api/atlas/v1.0/clusters' \
--header "Authorization: Bearer $ACCESS_TOKEN"{
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [
{
"clusters": [
{
"alertCount": 42,
"authEnabled": true,
"availability": "available",
"backupEnabled": true,
"clusterId": "string",
"dataSizeBytes": 42,
"name": "string",
"nodeCount": 42,
"sslEnabled": true,
"type": "REPLICA_SET",
"versions": [
"string"
]
}
],
"groupId": "string",
"groupName": "string",
"orgId": "string",
"orgName": "string",
"planType": "string",
"tags": [
"string"
]
}
],
"totalCount": 42
}{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}