/ /

Recursos

Tareas de recopilación de registros

Docs Home

Gestión

Gerente de Operaciones

API

Recursos

Tareas de recopilación de registros

Crear una tarea colectiva de registro

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.

Cuando crea una tarea de recopilación de registros, Ops Manager inicia una tarea en segundo plano para descargar los registros de la implementación de Ops Manager especificada. Utiliza este punto final para crear una nueva tarea de colección de registros.

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

Resource

POST /groups/{GROUP-ID}/logCollectionJobs

Parámetros de ruta de solicitud

Nombre	Tipo	Necesidad	Descripción
ID del grupo	string	Requerido	Cadena única de 24 dígitos hexadecimales que identifica la tarea de solicitud de colección de registros.

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

Nombre	Tipo	Necesidad	Descripción
resourceType	string	Requerido	Tipo de recurso del que recoger registros. Debe ser uno de los siguientes valores: `CLUSTER`para un clúster fragmentado. `PROCESS`, para un nodo en el set de réplicas. `REPLICASET`, para un set de réplicas.
nombreDelRecurso	string	Requerido	Nombre del recurso del que se recopilarán los registros. El tipo de recurso define el valor: Para el `CLUSTER` `resourceType`, el valor es el nombre de la implementación o el `CLUSTER-ID`. Por ejemplo, `my-deployment`. Para obtener este valor, usa el endpoint /groups/{ID del grupo}/clústeres/{CLUSTER-ID}. Para el `PROCESS` `resourceType`, el valor es el nombre del set de réplicas seguido por el nombre del nodo. Se puede mencionar, por ejemplo, `Cluster0-shard-1-node-0`. Para obtener este valor, use el punto de conexión /groups/{ID del grupo}/automationConfig. El valor se encuentra en el parámetro `processes.name`. Para obtener el nombre del set de réplicas, la lista de nodos y otra información, accede al clúster y ejecuta `rs.conf()._id` y `rs.status()`. Para el `REPLICASET` `resourceType`, el valor es el nombre del set de réplicas en el clúster seguido por el nombre de la partición. Se puede mencionar, por ejemplo, `test-123abc-shard-0`.
tamañoSolicitadoPorArchivoBytes	Número	Requerido	Tamaño de cada entrada de registro en bytes.
typeslog	arreglo	Requerido	Arreglo de cadenas que especifican los tipos de registros que se recolectarán. Cada elemento del arreglo debe ser uno de los siguientes valores: `AUTOMATION_AGENT` `BACKUP_AGENT` `MONITORING_AGENT` `MONGODB` `FTDC`
redactado	booleano	Requerido	Si se establece en `true`, los correos electrónicos, los nombres de host, las direcciones IP y los espacios de nombres en las respuestas de la API que involucran esta tarea se reemplazan con valores de string aleatorios.
recolecciónDeRegistrosDesdeFecha	entero	Opcional	Fecha y hora desde la que comenzar este registro, en milisegundos desde la Unix epoch. Si especificas el `logCollectionFromDate`, también debes especificar el `logCollectionToDate`.
logCollectionToDate	entero	Opcional	Fecha y hora en la que se debe finalizar este registro, en milisegundos desde la Unix epoch. Si especificas el `logCollectionToDate`, también debes especificar el `logCollectionFromDate`.

Respuesta

Nombre	Tipo	Descripción
ID	string	Identificador único de la tarea de recopilación de registros creada.

Solicitud de ejemplo

1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2      --header "Accept: application/json" \
3      --header "Content-Type: application/json" \
4      --include \
5      --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs?pretty=true" \
6      --data '
7        {
8          "resourceType": "PROCESS",
9          "resourceName": "my_deployment_1",
10          "redacted": true,
11          "sizeRequestedPerFileBytes": 10000000,
12          "logTypes": [
13              "FTDC",
14              "MONGODB",
15              "AUTOMATION_AGENT"
16          ]
17        }'

Respuesta de ejemplo

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 201 Created
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}

Respuesta del cuerpo

1 { "id": "5c81086e014b76a3d85e1113" }

Volver

Descargar registros

Prolongar

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--include \
5	--request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs?pretty=true" \
6	--data '
7	{
8	"resourceType": "PROCESS",
9	"resourceName": "my_deployment_1",
10	"redacted": true,
11	"sizeRequestedPerFileBytes": 10000000,
12	"logTypes": [
13	"FTDC",
14	"MONGODB",
15	"AUTOMATION_AGENT"
16	]
17	}'