Obtén un clúster en un proyecto

Recupera detalles de un clúster 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/{CLUSTER-ID}

Parámetros de ruta de solicitud

Nombre	Tipo	Descripción
`PROJECT-ID`	string	Identificador único para el proyecto.
`CLUSTER-ID`	string	Identificador único del clúster que desea recuperar.

Parámetros de Solicitud Query

Los siguientes parámetros de query son opcionales:

Nombre	Tipo	Necesidad	Descripción	predeterminado
bonito	booleano	Opcional	Indicador que muestra si el cuerpo de la respuesta está en formato pretty-print.	`false`
envelope	booleano	Opcional	Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, ajusta envelope=true en la query. Para los endpoints que devuelven un resultado, el cuerpo de la respuesta incluye: `status`: Código de respuesta HTTP `content`: Cuerpo de respuesta esperado	`false`

Parámetros del cuerpo de la solicitud

Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.

Respuesta

Parámetros de respuesta

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 formato de fecha y hora ISO 8601 en UTC cuando Ops Manager procesó por última vez un ping desde este clúster.
`replicaSetName`	string	Nombre del set 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: `REPLICA_SET`: Un set de réplicas. `SHARDED`: Un clúster particionado donde cada partición es una instancia autónoma. No particiones son sets de réplicas. `SHARDED_REPLICA_SET`: Un clúster particionado que contiene al menos una partición que es un set de réplicas. `CONFIG_SERVER_REPLICA_SET`: Servidores de configuración implementados 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/{CLUSTER-ID}?pretty=true"

Respuesta de ejemplo

Encabezado de respuesta

HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-alive

HTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Respuesta del cuerpo

1{2  "clusterName": "myRS",3  "groupId": "5e84b94c003f2d6370004f4e",4  "id": "5e8ba20e87d9396ca9b96bd0",5  "lastHeartbeat": "2020-06-10T14:51:28Z",6  "links": [7    {8      "href": "https://example.com:8080/api/public/v1.0/groups/5e84b94c003f2d6370004f4e/clusters/5e8ba20e87d9396ca9b96bd0",9      "rel": "self"10    }11  ],12  "replicaSetName": "myRS",13  "typeName": "REPLICA_SET"14}

Volver

Obtén todo de un solo proyecto

Update