/ /

/ /

Obtenga un proyecto por nombre

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.

Nota

Grupos y proyectos son términos sinónimos. Tu {PROJECT-ID} Es el mismo que el ID de tu proyecto. Para los grupos existentes, el ID de tu grupo/proyecto permanece igual. Esta página utiliza el término "grupo" para las descripciones. El punto final se mantiene como se indica en el documento.

URL base: https://cloud.mongodb.com/api/public/v1.0

Resource

GET /groups/byName/{GROUP-NAME}

Request Parameters

Parámetros de la ruta de solicitud

Nombre	Tipo	Descripción
NOMBRE DEL GRUPO	string	(Obligatorio.) El nombre del proyecto.

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

Nombre	Tipo	Descripción
activeAgentCount	entero	Número de agentes activos que envían pings regulares a Cloud Manager. El valor se actualiza aproximadamente cada 24 horas y se almacena en caché. Si inicia un nuevo agente o detiene uno existente, el cambio puede tardar hasta 30 minutos en aparecer en el campo `activeAgentCount`.
hostCounts	Objeto	Número total de hosts por tipo. Los campos incrustados deberían ser autoexplicativos.
ID.	string	Identificador único para el grupo.
último agente activo	string	Hora en que Cloud Manager actualizó por última vez el total de `activeAgentCount` para el proyecto. Cloud Manager actualiza este valor cada 24 horas y lo almacena en caché para registrar la cantidad de agentes MongoDB activos.
enlaces	matriz de objetos	Uno o más enlaces a subrecursos o recursos relacionados. Todas las `links` matrices en las respuestas incluyen al menos un enlace `self` llamado. Las relaciones entre las URLse explican en la Especificación de Enlaces Web.
Nombre	string	Nombre para mostrar del proyecto.
orgId	string	Identificador único de la organización a la que pertenece el proyecto.
publicApiEnabled	booleano	Indicador que indica que la API está habilitada para este proyecto. Este campo es de solo lectura y siempre `true` es.
recuento de conjuntos de réplicas	entero	Número total de conjuntos de réplicas para este proyecto.
recuento de fragmentos	entero	Número total de fragmentos para este proyecto.

Ejemplo de solicitud

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --include \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/byName/{GROUP-NAME}?pretty=true"

Importante

Algunos caracteres no están permitidos en las URL. Se denominan caracteres reservados. Si su {GROUP-NAME} incluye caracteres reservados, como espacios, debe reemplazarlos con su porcentaje de codificación.

Por ejemplo, en lugar de realizar esta solicitud (a través de curl):

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
 --header "Accept: application/json" \
 --include \
 --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/byName/My%20Project?pretty=true"

Realizar esta solicitud (vía curl):

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
 --header "Accept: application/json" \
 --include \
 --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/byName/My%20Group?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

{
  "activeAgentCount": 1,
  "agentApiKey": "{AGENT-API-KEY}",
  "hostCounts": {
    "arbiter": 2,
    "config": 1,
    "primary": 4,
    "secondary": 8,
    "mongos": 2
  },
  "id": "{PROJECT-ID}",
  "lastActiveAgent": ISODate("2016-08-05T07:23:34Z"),
  "links" : [],
  "name": "My Project",
  "orgId" : "111111111cccccf38dc78bdf",
  "publicApiEnabled": true,
  "replicaSetCount": 3,
  "shardCount": 2,
}

Volver

Obtener por identificación

Obtener la clave API del agente