Para agentes de IA: hay un índice de documentación disponible en https://www.mongodb.com/es/docs/llms.txt — versiones en markdown de todas las páginas están disponibles agregando .md a cualquier ruta URL.

Obtén todos los clústeres en un Proyecto

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

Puedes llamar eficazmente a este endpoint con cualquier rol asignado.

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

GET /groups/{PROJECT-ID}/clusters
Nombre
Tipo
Descripción

PROJECT-ID

string

Identificador único para el proyecto.

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

Indicador que señala si el cuerpo de la respuesta debe estar en formato prettyprint.

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 corregir esto, establezca envelope : true en la query.

Para los endpoints que devuelven una lista de resultados, el objeto content es un sobre. Cloud Manager añade el campo status al cuerpo de la respuesta.

false

backupJobsEnabledOnly

booleano

Opcional

Indicador que indica si se deben excluir los demonios que no están habilitados para hacer copias de seguridad de bases de datos de la respuesta. Establece esto en false para incluir las configuraciones del demonio con la bandera backupJobsEnabled establecida en false.

true

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

El JSON documento de respuesta incluye un arreglo de objetos result, un arreglo de objetos link y un recuento del número total de objetos result recuperados.

Nombre
Tipo
Descripción

results

arreglo

El arreglo incluye un objeto para cada elemento detallado en la sección del 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.

Cada resultado es un clúster.

Nombre
Tipo
Descripción

clusterName

string

Nombre para mostrar del clúster. Ten en cuenta que mongod en sí no permite nombrar un clúster; Cloud Manager proporciona ese nombre y puedes actualizarlo. 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 Cloud Manager procesó más recientemente un ping de este clúster.

replicaSetName

string

Nombre del set 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:

  • 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.

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?pretty=true"
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}
{ "links": [ { "href": "https://cloud.mongodb.com/api/public/v1.0/groups/5e84b94c003f2d6370004f4e/clusters?pageNum=1&itemsPerPage=100", "rel": "self" } ], "results": [ { "clusterName": "myRS", "groupId": "5e84b94c003f2d6370004f4e", "id": "5e8ba20e87d9396ca9b96bd0", "lastHeartbeat": "2020-06-10T14:51:28Z", "links": [ { "href": "https://cloud.mongodb.com/api/public/v1.0/groups/5e84b94c003f2d6370004f4e/clusters/5e8ba20e87d9396ca9b96bd0", "rel": "self" } ], "replicaSetName": "myRS", "typeName": "REPLICA_SET" }, { "clusterName": "cm-clstr-repl", "groupId": "5e84b94c003f2d6370004f4e", "id": "5e84e393395ec72bfc888f6c", "lastHeartbeat": "2020-06-10T15:20:08Z", "links": [ { "href": "https://cloud.mongodb.com/api/public/v1.0/groups/5e84b94c003f2d6370004f4e/clusters/5e84e393395ec72bfc888f6c", "rel": "self" } ], "replicaSetName": "cm-clstr-repl", "typeName": "REPLICA_SET" } ], "totalCount": 2}