/ /

/ /

Obtenga un clúster en un 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 un clúster 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/{CLUSTER-ID}

Parámetros de la ruta de solicitud

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

Parámetros de consulta de solicitud

Los siguientes parámetros de consulta son opcionales:

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

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/{CLUSTER-ID}?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   "clusterName": "myRS",
3   "groupId": "5e84b94c003f2d6370004f4e",
4   "id": "5e8ba20e87d9396ca9b96bd0",
5   "lastHeartbeat": "2020-06-10T14:51:28Z",
6   "links": [
7     {
8       "href": "https://cloud.mongodb.com/api/public/v1.0/groups/5e84b94c003f2d6370004f4e/clusters/5e8ba20e87d9396ca9b96bd0",
9       "rel": "self"
10     }
11   ],
12   "replicaSetName": "myRS",
13   "typeName": "REPLICA_SET"
14 }

Volver

Obtenga todo en un solo proyecto

Actualiza uno

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