/ /

/ /

Obtenga todos los clústeres en un solo proyecto

Cloud Manager dejará de ofrecer compatibilidad con automatización, copias de seguridad y monitorización para MongoDB 3.6 y 4.0 a partir del 30de agosto de 2024. Por favor, Actualice su implementación de MongoDB o migre a Atlas.

Recupere detalles de todos los clústeres en un proyecto.

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 /groups/{PROJECT-ID}/clusters

Parámetros de la ruta de solicitud

Nombre	Tipo	Descripción
`PROJECT-ID`	string	Identificador único del proyecto.

Parámetros de consulta de solicitud

Los siguientes parámetros de consulta son opcionales:

Nombre	Tipo	Necesidad	Descripción	predeterminado
número de página	Número	Opcional	Entero basado en uno que devuelve una subsección de resultados.	`1`
artículos por página	Número	Opcional	Número de artículos a devolver por página, hasta un máximo de 500.	`100`
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 endpoints que devuelven una lista de resultados, el objeto `content` es un sobre. Cloud Manager añade el campo `status` al cuerpo de la respuesta.	`false`
trabajos de respaldo habilitados solamente	booleano	Opcional	Indicador que indica si se deben excluir de la respuesta los daemons no habilitados para realizar copias de seguridad de bases de datos. Establezca este valor en `false` para incluir las configuraciones de daemon con el indicador `backupJobsEnabled` establecido en `false`.	`true`

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ón`results` 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 cluster.

Nombre

Tipo

Descripción

clusterName

string

Nombre para mostrar del clúster. Tenga en cuenta que mongod no permite asignar un nombre a un clúster; Cloud Manager proporciona este nombre y usted puede actualizarlo. Para un conjunto de réplicas dentro de un clúster fragmentado, el nombre del clúster es el nombre de su clúster principal.

groupId

string

Identificador único del proyecto al que pertenece el cluster.

id

string

Identificador único del clúster.

lastHeartbeat

fecha

Marca de tiempo en formato de fecha y hora ISO 8601 en UTC cuando Cloud Manager procesó por última vez un ping desde este clúster.

replicaSetName

string

Nombre del conjunto de réplicas. Cloud Manager devuelve este valor cuando un clúster tiene un typeName de REPLICA_SET o CONFIG_SERVER_REPLICA_SET.

shardName

string

Nombre de la partición. Cloud Manager devuelve este valor cuando un clúster tiene una typeName de SHARDED o un REPLICA_SET que forma parte de un clúster fragmentado.

typeName

string

Tipo de clúster. Cloud Manager puede devolver:

`typeName`	Descripción
`REPLICA_SET`	Un conjunto de réplicas.
`SHARDED`	Un clúster fragmentado donde cada fragmento es una instancia independiente. Ningún fragmento es un conjunto de réplicas.
`SHARDED_REPLICA_SET`	Un clúster fragmentado que contiene al menos un fragmento que es un conjunto de réplicas.
`CONFIG_SERVER_REPLICA_SET`	Servidores de configuración implementados como un conjunto de réplicas.

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/groups/{PROJECT-ID}/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/groups/5e84b94c003f2d6370004f4e/clusters?pageNum=1&itemsPerPage=100",
5       "rel": "self"
6     }
7   ],
8   "results": [
9     {
10       "clusterName": "myRS",
11       "groupId": "5e84b94c003f2d6370004f4e",
12       "id": "5e8ba20e87d9396ca9b96bd0",
13       "lastHeartbeat": "2020-06-10T14:51:28Z",
14       "links": [
15         {
16           "href": "https://cloud.mongodb.com/api/public/v1.0/groups/5e84b94c003f2d6370004f4e/clusters/5e8ba20e87d9396ca9b96bd0",
17           "rel": "self"
18         }
19       ],
20       "replicaSetName": "myRS",
21       "typeName": "REPLICA_SET"
22     },
23     {
24       "clusterName": "cm-clstr-repl",
25       "groupId": "5e84b94c003f2d6370004f4e",
26       "id": "5e84e393395ec72bfc888f6c",
27       "lastHeartbeat": "2020-06-10T15:20:08Z",
28       "links": [
29         {
30           "href": "https://cloud.mongodb.com/api/public/v1.0/groups/5e84b94c003f2d6370004f4e/clusters/5e84e393395ec72bfc888f6c",
31           "rel": "self"
32         }
33       ],
34       "replicaSetName": "cm-clstr-repl",
35       "typeName": "REPLICA_SET"
36     }
37   ],
38   "totalCount": 2
39 }

Volver

Obtenga todo en todos los proyectos

Consigue uno

1	{
2	"links": [
3	{
4	"href": "https://cloud.mongodb.com/api/public/v1.0/groups/5e84b94c003f2d6370004f4e/clusters?pageNum=1&itemsPerPage=100",
5	"rel": "self"
6	}
7	],
8	"results": [
9	{
10	"clusterName": "myRS",
11	"groupId": "5e84b94c003f2d6370004f4e",
12	"id": "5e8ba20e87d9396ca9b96bd0",
13	"lastHeartbeat": "2020-06-10T14:51:28Z",
14	"links": [
15	{
16	"href": "https://cloud.mongodb.com/api/public/v1.0/groups/5e84b94c003f2d6370004f4e/clusters/5e8ba20e87d9396ca9b96bd0",
17	"rel": "self"
18	}
19	],
20	"replicaSetName": "myRS",
21	"typeName": "REPLICA_SET"
22	},
23	{
24	"clusterName": "cm-clstr-repl",
25	"groupId": "5e84b94c003f2d6370004f4e",
26	"id": "5e84e393395ec72bfc888f6c",
27	"lastHeartbeat": "2020-06-10T15:20:08Z",
28	"links": [
29	{
30	"href": "https://cloud.mongodb.com/api/public/v1.0/groups/5e84b94c003f2d6370004f4e/clusters/5e84e393395ec72bfc888f6c",
31	"rel": "self"
32	}
33	],
34	"replicaSetName": "cm-clstr-repl",
35	"typeName": "REPLICA_SET"
36	}
37	],
38	"totalCount": 2
39	}

Roles necesarios

Solicitud

Parámetros de la ruta de solicitud

Parámetros de consulta de solicitud

Parámetros del cuerpo de la solicitud

Respuesta

Parámetros de respuesta

Documento de respuesta

results Documento incrustado

Ejemplo de solicitud

Ejemplo de respuesta

Encabezado de respuesta

Cuerpo de respuesta

`results` Documento incrustado