Crear un trabajo de recopilación de registros

Esta versión de la documentación está archivada y ya no se admite. Ver la Documentación actual para aprender cómo actualizar su versión de MongoDB Ops Manager.

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.

Al crear un trabajo de recopilación de registros, Ops Manager inicia un trabajo en segundo plano para descargar los registros de la implementación de Ops Manager especificada. Utilice este punto de conexión para crear un nuevo trabajo de recopilación de registros.

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

Resource

POST /groups/{GROUP-ID}/logCollectionJobs

Parámetros de la ruta de solicitud

Nombre	Tipo	Necesidad	Descripción
ID DE GRUPO	string	Requerido	Cadena de dígitos hexadecimales 24única que identifica el trabajo de solicitud de recopilación de registros.

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
Estado	Código de respuestaHTTP
envolvente	Cuerpo de respuesta esperado

false

Parámetros del cuerpo de la solicitud

Nombre	Tipo	Necesidad	Descripción
tipo de recurso	string	Requerido	Tipo de recurso del que se recopilan los registros. Debe ser uno de los siguientes valores: `CLUSTER`, para un clúster fragmentado. `PROCESS`, para un nodo en el conjunto de réplicas. `REPLICASET`, para un conjunto de réplicas.
nombreRecurso	string	Requerido	Nombre del recurso del que se recopilan los registros. El tipo de recurso define el valor: Para `CLUSTER` `resourceType`, el valor es el nombre de la implementación o `CLUSTER-ID`. Por ejemplo, `my-deployment`. Para obtener este valor, utilice el /groups/{GROUP-ID}/clusters/{CLUSTER-ID} punto final. Para `PROCESS` `resourceType`, el valor es el nombre del conjunto de réplicas seguido del nombre del nodo. Por ejemplo, `Cluster0-shard-1-node-0`. Para obtener este valor, utilice el punto de conexión /groups/{PROJECT-ID}/automationConfig. El valor se encuentra en el `processes.name` parámetro. Para obtener el nombre del conjunto de réplicas, la lista de nodos y otra información, acceda al clúster y ejecute `rs.conf()._id` `rs.status()`y. Para `REPLICASET` `resourceType`, el valor es el nombre del conjunto de réplicas en el clúster, seguido del nombre del fragmento. Por ejemplo, `test-123abc-shard-0`.
tamaño solicitado por bytes de archivo	Número	Requerido	Tamaño de cada archivo de registro en bytes.
tipos de registro	arreglo	Requerido	Matriz de cadenas que especifica los tipos de registros que se recopilarán. Cada elemento de la matriz debe tener 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, nombres de host, direcciones IP y espacios de nombres en las respuestas de API que involucran este trabajo se reemplazan con valores de cadena aleatorios.

Respuesta

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

Ejemplo de solicitud

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        }'

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

Cuerpo de respuesta

1 { "id": "5c81086e014b76a3d85e1113" }

Volver

Descargar registros

Ampliar

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	}'