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 ruta de solicitud
Nombre | Tipo | Descripción |
|---|---|---|
| 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. |
|
elementosPorPágina | Número | Opcional | Número de elementos a devolver por página, hasta un máximo de 500. |
|
bonito | booleano | Opcional | Indicador que indica si el cuerpo de la respuesta debe estar en un prettyprint formato. |
|
envelope | booleano | Opcional | Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos clientes de API no pueden acceder a los encabezados de respuesta HTTP o al código de estado. Para remediar esto, establezca Para los endpoints que devuelven una lista de resultados, el objeto |
|
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
La respuesta JSON documento incluye un arreglo de result objetos, un arreglo de link objetos y un recuento del número total de result objetos recuperados.
Nombre | Tipo | Descripción |
|---|---|---|
| arreglo | El arreglo incluye un objeto para cada elemento detallado en la sección del |
| 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. |
| 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 clúster.
Nombre | Tipo | Descripción | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| string | Display name of the cluster. Note that | ||||||||||
| string | Identificador único del proyecto al que pertenece el clúster. | ||||||||||
| string | Identificador único del clúster. | ||||||||||
| fecha | Marca de tiempo en formato de fecha y hora ISO 8601 en UTC cuando MongoDB Ops Manager procesó más recientemente un ping de este clúster. | ||||||||||
| string | Nombre del set de réplicas. Ops Manager devuelve este valor cuando un clúster tiene un | ||||||||||
| string | Nombre de la partición. Ops Manager devuelve este valor cuando un clúster tiene una | ||||||||||
| string | Tipo de clúster. Ops Manager puede devolver:
|
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
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
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 }