Join us at MongoDB.local London on 7 May to unlock new possibilities for your data. Use WEB50 to save 50%.
Register now >
Docs Menu
Docs Home
/ /
Clústeres
Docs Home
/ /
Implementaciones
/
Clústeres
Docs Home
/
Gestión
/
Gerente de Operaciones
/
API
/
Recursos
/
Implementaciones
/
Clústeres

Obtenga todos los clústeres en un solo proyecto

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

Roles necesarios

Puedes llamar eficazmente a este endpoint con cualquier rol asignado.

Solicitud

URL base: https://{OPSMANAGER-HOST}:{PORT}/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 para el proyecto.

Parámetros de Solicitud Query

Los siguientes parámetros de query son opcionales:

Nombre
Tipo
Necesidad
Descripción
predeterminado

Num. de pág.

Número

Opcional

Entero basado en uno que devuelve una subsección de resultados.

1

elementosPorPágina

Número

Opcional

Número de elementos a devolver por página, hasta un máximo de 500.

100

bonito

booleano

Opcional

Bandera que indica si el cuerpo de la respuesta debe estar en una pretty-print formato.

false

envelope

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. Ops Manager agrega el campo status al cuerpo de la respuesta.

false

Parámetros del cuerpo de la solicitud

Este endpoint no utiliza parámetros de cuerpo de 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 Documento incrustado.

links

arreglo

El arreglo incluye uno o más enlaces a subrecursos y/o recursos relacionados. Las relaciones entre URLse explican en la Especificación de enlace web.

totalCount

Número

Recuento entero del número total de elementos en el conjunto de resultados. Puede ser superior al número de objetos en el arreglo results si el conjunto de resultados completo está paginado.

results embeddedDocument

Cada resultado es un cluster.

Nombre
Tipo
Descripción

clusterName

string

Nombre para mostrar del clúster. Tenga en cuenta que mongod en sí mismo no le permite nombrar un clúster; Ops Manager proporciona este nombre y se puede actualizar. Para un set de réplicas dentro de un clúster fragmentado, el nombre del clúster es el nombre de su clúster parental.

groupId

string

Identificador único del proyecto al que pertenece el clúster.

id

string

Identificador único del clúster.

lastHeartbeat

fecha

Marca de tiempo en ISO 8601 formato de fecha y hora en UTC cuando el Ops Manager procesó más recientemente un ping de este clúster.

replicaSetName

string

Nombre del conjunto de réplicas. Ops 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. Ops 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. Ops Manager puede devolver:

typeName
Descripción

REPLICA_SET

Un set de réplicas.

SHARDED

Un clúster particionado donde cada partición es una instancia autónoma. Ninguna partición es un set de réplicas.

SHARDED_REPLICA_SET

Un clúster fragmentado que contiene al menos una partición que es un set de réplicas.

CONFIG_SERVER_REPLICA_SET

Servidores de configuración desplegados como un set de réplicas.

Solicitud de ejemplo

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/clusters?pretty=true"

Respuesta de ejemplo

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}

Respuesta del cuerpo

1{
2  "links": [
3    {
4      "href": "https://example.com:8080/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://example.com:8080/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://example.com:8080/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

Obtener todo de todos los proyectos

Next

Obtenga uno

En esta página