Docs Menu
Docs Home
/ /
Clústeres
Docs Home
/ /
Implementaciones
/
Clústeres
Docs Home
/
Gestión
/
Cloud Manager
/
API
/
Recursos
/
Implementaciones
/
Clústeres

Obtener todos los clústeres en todos los proyectos

Obtenga detalles de todos los clústeres en todos los proyectos disponibles para la clave API programática que realiza la solicitud.

Roles necesarios

Puede llamar a este punto final con éxito con cualquier rol asignado.

Solicitud

URL base: https://cloud.mongodb.com/api/public/v1.0

GET /api/public/v1.0/clusters

Parámetros de la ruta de solicitud

Este punto final no utiliza parámetros de ruta de solicitud HTTP.

Parámetros de consulta de solicitud

Nombre
Tipo
Necesidad
Descripción
predeterminado

bonita

booleano

Opcional

Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint formato.

false

envolvente

booleano

Opcional

Bandera que indica si se debe o no envolver la respuesta en un sobre.

Algunos Los clientes de laAPI no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure envelope=true en la consulta.

Para los puntos finales que devuelven un resultado, el cuerpo de la respuesta incluye:

Nombre
Descripción

status

Código de respuestaHTTP

content

Cuerpo de respuesta esperado

false

Parámetros del cuerpo de la solicitud

Este punto final no utiliza parámetros del cuerpo de la solicitud HTTP.

Respuesta

Parámetros de respuesta

Documento de respuesta

El documento JSON de respuesta incluye una matriz de result objetos, una matriz de link objetos y un recuento del número total de result objetos recuperados.

Nombre
Tipo
Descripción

results

arreglo

La matriz incluye un objeto para cada elemento detallado en el Secciónresults de documento incrustado.

links

arreglo

La matriz incluye uno o más enlaces a subrecursos o recursos relacionados. Las relaciones entre las URLse explican en la Especificación de Enlaces Web.

totalCount

Número

Número entero del número total de elementos en el conjunto de resultados. Puede ser mayor que el número de objetos en la matriz results si todo el conjunto de resultados está paginado.

results Documento incrustado

Cada resultado es un proyecto.

Nombre
Tipo
Descripción

clusters

matriz de objetos

Objetos que describen los clústeres en cada proyecto que la clave API está autorizada a ver.

clusters.[n].alertCount

entero

Número de alertas abiertas.

clusters.[n].authEnabled

booleano

Especifica si se requiere autenticación para acceder a los nodos del clúster.

clusters.[n].availability

string

Disponibilidad del clúster. Los valores incluyen:

  • available: Todos los nodos en el clúster están disponibles.

  • warningAlgunos nodos del clúster están disponibles. Al menos un nodo no está disponible.

  • unavailableEl clúster no está disponible. No tiene un nodo principal.

  • dead:El cluster está inactivo.

clusters.[n].backupEnabled

booleano

Especifica si la copia de seguridad está habilitada para el clúster.

clusters.[n].clusterId

string

Identificador único del clúster de Cloud Manager.

clusters.[n].dataSizeBytes

Número

Tamaño total de los datos almacenados en cada nodo del clúster en bytes.

clusters.[n].name

string

Nombre del clúster tal como aparece en Cloud Manager.

clusters.[n].nodeCount

entero

Número de nodos en el clúster.

clusters.[n].sslEnabled

booleano

Especifica si se requiere autenticación SSL para acceder a los nodos del clúster.

clusters.[n].type

string

El tipo de clúster de MongoDB. Los valores incluyen:

clusters.[n].versions

matriz de cadenas

Versión de MongoDB que ejecuta cada nodo del clúster.

groupId

string

Identificador único del proyecto.

groupName

string

Nombre del proyecto al que pertenecen los clústeres devueltos.

orgId

string

Identificador único de la organización propietaria del proyecto al que pertenecen los clústeres devueltos.

orgName

string

Nombre de la organización propietaria del proyecto al que pertenecen los clústeres devueltos.

planType

string

Tipo de plan.

En Cloud Manager, este valor siempre es Cloud Manager.

tags

matriz de cadenas

Etiquetas aplicadas al proyecto.

Ejemplo de solicitud

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/clusters?pretty=true"

Ejemplo de respuesta

Encabezado de respuesta

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Cuerpo de respuesta

1{
2  "links" : [
3    {
4      "href" : "https://cloud.mongodb.com/api/public/v1.0/clusters",
5      "rel" : "self"
6    }
7  ],
8  "results" : [
9    {
10      "clusters" : [
11        {
12          "alertCount" : 0,
13          "authEnabled" : true,
14          "availability" : "available",
15          "backupEnabled" : false,
16          "clusterId" : "5e6bc0352e41683c191c8956",
17          "dataSizeBytes" : 0,
18          "name" : "Cluster1",
19          "nodeCount" : 3,
20          "sslEnabled" : true,
21          "type" : "replica set",
22          "versions" : [
23            "4.2.3"
24          ]
25        },
26        {
27          "alertCount" : 0,
28          "authEnabled" : true,
29          "availability" : "available",
30          "backupEnabled" : false,
31          "clusterId" : "5e6bc60ba4c3f47a54d8fe95",
32          "dataSizeBytes" : 0,
33          "name" : "Cluster2",
34          "nodeCount" : 3,
35          "sslEnabled" : true,
36          "type" : "replica set",
37          "versions" : [
38            "4.2.3"
39          ]
40        }
41      ],
42      "groupId" : "5df90932f10fab675508b0e5",
43      "groupName" : "az",
44      "orgId" : "5df7a168f10fab3a149357fb",
45      "orgName" : "jww-12-16",
46      "planType" : "Cloud Manager",
47      "tags" : [
48
49      ]
50    },
51    {
52      "clusters" : [
53        {
54          "alertCount" : 0,
55          "authEnabled" : true,
56          "availability" : "available",
57          "backupEnabled" : false,
58          "clusterId" : "5e6bbf6a9de0d35b1527dd93",
59          "dataSizeBytes" : 0,
60          "name" : "Cluster0",
61          "nodeCount" : 3,
62          "sslEnabled" : true,
63          "type" : "replica set",
64          "versions" : [
65            "4.2.3"
66          ]
67        }
68      ],
69      "groupId" : "5df90590f10fab5e33de2305",
70      "groupName" : "jww-12-17",
71      "orgId" : "5df7a168f10fab3a149357fb",
72      "orgName" : "jww-12-16",
73      "planType" : "Cloud Manager",
74      "tags" : [
75
76      ]
77    },
78    {
79      "clusters" : [
80        {
81          "alertCount" : 0,
82          "authEnabled" : true,
83          "availability" : "dead",
84          "backupEnabled" : false,
85          "clusterId" : "5e6be93fd434591c4ca765f6",
86          "dataSizeBytes" : 0,
87          "name" : "Cluster0",
88          "nodeCount" : 0,
89          "sslEnabled" : true,
90          "type" : "replica set",
91          "versions" : [
92            "4.2.3"
93          ]
94        }
95      ],
96      "groupId" : "5df90923f10fab675508b065",
97      "groupName" : "gcp",
98      "orgId" : "5df7a168f10fab3a149357fb",
99      "orgName" : "jww-12-16",
100      "planType" : "Cloud Manager",
101      "tags" : [
102
103      ]
104    }
105  ],
106  "totalCount" : 3
107}

Volver

Clústeres

Next

Obtenga todo en un solo proyecto

En esta página