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.

Iniciar un proceso con la API pública

Nota

Grupos y proyectos son términos sinónimos. Su {PROJECT-ID} es el mismo que su ID del grupo. Para los grupos existentes, el ID del grupo se mantiene igual. Esta página utiliza el término más familiar grupo cuando se refiere a descripciones. El endpoint permanece tal como se indica en el documento.

Utilice este endpoint para iniciar un proceso que previamente fue cerrado. Ops Manager establece disabled para false para el proceso en la configuración de automatización y publica el cambio.

La solicitud es asíncrona: 200 OK significa que Ops Manager publicó el cambio, no que el proceso esté en ejecución. Consulta el recurso de estado de automatización hasta que el plan se complete. Luego confirma que el replicaStateName del miembro en el 2v .0 Get One Host by ID endpoint vuelve a SECONDARY o PRIMARY.

Si el proceso ya está en ejecución, nada cambia y el agente no toma ninguna acción, pero Ops Manager sigue publicando la configuración y registrando el evento. Si el oplog se ha transferido mientras el proceso estaba inactivo, el miembro permanece en RECOVERING y no se resincroniza por sí solo. Usa Resincronizar un proceso en su lugar.

URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

POST /groups/{GROUP-ID}/process/{HOST-PORT}:startup

La clave API que realiza esta solicitud debe tener el rol Project Automation Admin.

Nombre
Tipo
Necesidad
Descripción

ID del grupo

string

Requerido

string única de 24 dígitos hexadecimales que identifica tu proyecto.

host-puerto

string

Requerido

Proceso objetivo, como hostname:port. Por ejemplo, node1.example.com:27017.

Nombre
Tipo
Necesidad
Descripción
predeterminado

dryRun (Ejecutar en seco)

booleano

Opcional

Si true, Ops Manager valida la solicitud y devuelve el proceso modificado sin publicarlo ni añadir un evento de feed de actividad. Ops Manager rechaza cualquier valor que no sea true o false con 400 INVALID_QUERY_PARAMETER.

false

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

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

Ops Manager devuelve 200 OK y el proceso objetivo tal como aparece en la configuración de automatización, con el cambio aplicado. disabled es false. El cuerpo es el mismo tanto si configuras dryRun como si no.

Nombre
Tipo
Descripción

Nombre

string

Nombre del proceso en la configuración de automatización.

Nombre del host

string

Nombre de host del proceso.

processType

string

Tipo de proceso, por ejemplo mongod.

Versión

string

Versión MongoDB del proceso.

inhabilitado

booleano

true si el proceso se cierra.

lastRestart

string

Marca de tiempo, en formato ISO 8601 UTC, del último reinicio solicitado.

lastResync

string

Marca de tiempo, en formato ISO 8601 UTC, de la última resincronización solicitada.

El documento también contiene el resto de la configuración de automatización del proceso, como args2_6, featureCompatibilityVersiony authSchemaVersion. Consulte la referencia de Configuración de Automatización .

El siguiente ejemplo inicia el proceso que se ejecuta en node1.example.com:27017.

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/process/node1.example.com:27017:startup?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}
{ "name": "rs0_1", "processType": "mongod", "version": "8.0.4", "hostname": "node1.example.com", "disabled": false, "authSchemaVersion": 5, "featureCompatibilityVersion": "8.0", "args2_6": { "net": { "port": 27017 }, "replication": { "replSetName": "rs0" }, "storage": { "dbPath": "/data/rs0_1" }, "systemLog": { "destination": "file", "path": "/data/rs0_1/mongodb.log" } }}
HTTP Status
Código de error
Descripción

200

--

El cambio fue publicado o calculado con dryRun=true. Devuelve el documento de proceso.

400

--

El proceso está en modo manual o la configuración de automatización falló en la validación. El mensaje explica por qué. No devuelto para una prueba en seco.

409

GROUP_IN_RESTORATION_MODE

El proyecto se está reconciliando tras una restauración.

403

PROCESS_EXTERNALLY_MANAGED

Los procesos del proyecto son gestionados por un sistema externo.

409

AUTOMATION_CONFIG_DRAFT_ALREADY_EXISTS

Tienes un borrador de configuración de automatización no publicado en el proyecto.

404

PROCESS_NOT_FOUND

HOST-PORT no coincide con un proceso en la configuración de automatización del proyecto.

400

INVALID_QUERY_PARAMETER

dryRun No es true ni false.

409

AUTOMATION_CONFIG_CONCURRENT_MODIFICATION

Alguien publicó un cambio mientras esta solicitud estaba en curso. Ops Manager devuelve este código solo para una solicitud real.

Ops Manager comprueba los errores compartidos en el orden indicado. Consulte Ciclo de vida del proceso para requisitos previos y limitaciones.