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.
Docs Menu

Obtener todos los trabajos de colección de registros para un Proyecto

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 se crea una tarea de colección de registros, el Ops Manager inicia una tarea en segundo plano para descargar los registros de la implementación específica de Ops Manager. Utilice este endpoint para recuperar todas las tareas de colección de registros para un Proyecto específico de Ops Manager.

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

GET /groups/{GROUP-ID}/logCollectionJobs
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.

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 indica si el cuerpo de la respuesta debe estar en un prettyprint formato.

false

envelope

booleano

Opcional

Bandera que indica si se debe o no envolver la respuesta en un sobre.

Algunos clientes de API 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 endpoints que devuelven una lista de resultados, el objeto content es un sobre. Ops Manager agrega el campo status al cuerpo de la respuesta.

false

verbose

Booleano

Opcional

Indicador que especifica si se deben incluir todas las tareas secundarias en la respuesta. Cada tarea de colección de registros contiene tareas secundarias para cada tipo de registro y proceso de MongoDB incluidos en la solicitud.

false

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

El documento JSON de respuesta incluye una matriz de objetos result, una matriz 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 equivale en si a una tarea de recopilación de registros.

Nombre
Tipo
Descripción

empleos secundarias

arreglo

Lista de tareas secundarias asociadas con esta solicitud. Incluido en la respuesta si configuras el parámetro de consulta verbose en true.

childJobs[n].errorMessage

string

Mensaje de error que muestra por qué falló esta tarea secundaria, si corresponde.

childJobs[n].finishDate

string

Marca de tiempo en formato de fecha y hora ISO 8601 en UTC cuando finalizó este trabajo secundario.

childJobs[n].hostName

string

Nombre del host del que la tarea secundaria recopila los registros.

childJobs[n].logCollectionType

string

Tipo de registro que esta tarea secundaria recopila. Devuelve uno de los siguientes valores:

  • AUTOMATION_AGENT

  • BACKUP_AGENT

  • MONITORING_AGENT

  • MONGODB

  • FTDC

childJobs[n].path

string

Ruta al proceso en la implementación para el cual esta tarea secundaria recopila registros. MongoDB Atlas utiliza estas rutas para construir la jerarquía de directorios en el archivo comprimido.

logCollectionType
ruta

AUTOMATION_AGENT

<hostname>/automation_agent

BACKUP_AGENT

<hostname>/automation_agent

MONITORING_AGENT

<hostname>/automation_agent

MongoDB

<hostname>/<port>/<mongodb>

FTDC

<hostname>/<port>/<ftdc>

childJobs[n].startDate

string

Marca de tiempo en formato de fecha y hora ISO 8601 en UTC cuando comenzó este trabajo secundario.

childJobs[n].status

string

Estado de esta tarea secundaria. Este recurso devuelve uno de los siguientes valores:

  • SUCCESS

  • FAILURE

  • IN_PROGRESS

  • MARKED_FOR_EXPIRY

  • EXPIRED

childJobs[n].uncompressedDiskSpaceBytes

Número

Espacio total no comprimido en disco en bytes que utiliza esta tarea secundaria.

creationDate

string

Marca de tiempo, en el número de segundos que han transcurrido desde la época UNIX cuando creaste la tarea de solicitud de recopilación de registros.

expirationDate

string

Marca de tiempo, en el número de segundos transcurridos desde la época UNIX cuando la tarea de solicitud de colección de registros expire.

ID del grupo

string

string única de 24dígitos hexadecimales que identifica el proyecto asociado con la solicitud de recopilación de registros.

ID

string

Cadena única de 24 dígitos hexadecimales que identifica la tarea de solicitud de colección de registros.

typeslog

arreglo

Lista de tipos de registros incluidos en esta solicitud. Este recurso devuelve uno o más de los siguientes valores:

  • AUTOMATION_AGENT

  • BACKUP_AGENT

  • MONITORING_AGENT

  • MONGODB

  • FTDC

redactado

booleano

Indicador que indica si la solicitud sustituye los correos electrónicos, nombres de host, direcciones IP y espacios de nombres en la respuesta por valores de cadena aleatorios.

nombreDelRecurso

string

Nombre del recurso para el que solicitaste registros.

resourceType

string

Tipo de recurso para el que solicitaste registros. Este recurso devuelve uno de los siguientes valores:

  • CLUSTER

  • PROCESS

  • REPLICA_SET

rootResourceName

string

Nombre de la completa implementación si realizó la solicitud de registro para una parte de una implementación. Parte de la implementación podría ser un set de réplicas en un clúster o una partición de un clúster particionado.

rootResourceType

string

Tipo de la parte de la implementación completa si hiciste la solicitud de registro a una parte de la implementación. Parte de la implementación podría ser un set de réplicas en un clúster o una partición de un clúster fragmentado. Este recurso retorna uno de los siguientes valores:

  • CLUSTER

  • PROCESS

  • REPLICA_SET

Estado

string

Estado de la tarea de solicitud de colección de registros. Este recurso devuelve uno de los siguientes valores:

  • SUCCESS

  • FAILURE

  • IN_PROGRESS

  • MARKED_FOR_EXPIRY

  • EXPIRED

tamañoSolicitadoPorArchivoBytes

Número

Tamaño de cada entrada de registro en bytes.

uncompressedSizeTotalBytes

Número

Tamaño total sin comprimir de los datos del registro en bytes que devuelve esta solicitud.

ID de usuario

string

string única de 24 dígitos hexadecimales que identifica al usuario que ejecuta la solicitud.

downloadUrl

string

Dirección de Internet desde la que descargas los registros de esta solicitud.

1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2 --header "Accept: application/json" \
3 --include \
4 --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs?verbose=true&pretty=true"
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}
1{
2 "links": [
3 {
4 "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs?verbose=true&pageNum=1&itemsPerPage=100",
5 "rel": "self"
6 }
7 ],
8 "results": [
9 {
10 "childJobs": [
11 {
12 "automationAgentId": "5c810cc4ff7a256345ff97bf",
13 "errorMessage": null,
14 "finishDate": "2019-03-07T12:21:30Z",
15 "hostName": "server1.example.com",
16 "logCollectionType": "AUTOMATION_AGENT",
17 "path": "server1.example.com/automation_agent",
18 "startDate": "2019-03-07T12:21:24Z",
19 "status": "SUCCESS",
20 "uncompressedDiskSpaceBytes": 14686
21 }
22 ],
23 "creationDate": "2019-03-07T12:21:24Z",
24 "downloadUrl": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs/5c810cc4ff7a256345ff97b7/download",
25 "expirationDate": "2019-04-06T12:21:24Z",
26 "groupId": "5c8100bcf2a30b12ff88258f",
27 "id": "5c810cc4ff7a256345ff97b7",
28 "logTypes": [
29 "AUTOMATION_AGENT",
30 "MONGODB"
31 ],
32 "redacted": true,
33 "resourceName": "myReplicaSet",
34 "resourceType": "replicaset",
35 "rootResourceName": "myReplicaSet",
36 "rootResourceType": "replicaset",
37 "sizeRequestedPerFileBytes": 1000,
38 "status": "SUCCESS",
39 "uncompressedSizeTotalBytes": 63326,
40 "userId": "5c80f75fcf09a246878f67a4"
41 },
42 {
43 "childJobs": [
44 {
45 "automationAgentId": "5c81086e014b76a3d85e1117",
46 "errorMessage": null,
47 "finishDate": "2019-03-07T12:02:57Z",
48 "hostName": "server1.example.com:27027",
49 "logCollectionType": "MONGODB",
50 "path": "server1.example.com/27027/mongodb",
51 "startDate": "2019-03-07T12:02:54Z",
52 "status": "SUCCESS",
53 "uncompressedDiskSpaceBytes": 9292
54 }
55 ],
56 "creationDate": "2019-03-07T12:02:54Z",
57 "downloadUrl": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs/5c81086e014b76a3d85e1113/download",
58 "expirationDate": "2019-05-06T12:02:54Z",
59 "groupId": "5c8100bcf2a30b12ff88258f",
60 "id": "5c81086e014b76a3d85e1113",
61 "logTypes": [
62 "MONGODB",
63 "FTDC",
64 "AUTOMATION_AGENT"
65 ],
66 "redacted": false,
67 "resourceName": "myReplicaSet",
68 "resourceType": "replicaset",
69 "rootResourceName": "myReplicaSet",
70 "rootResourceType": "replicaset",
71 "sizeRequestedPerFileBytes": 1000,
72 "status": "IN_PROGRESS",
73 "uncompressedSizeTotalBytes": 44518,
74 "userId": "5c80f75fcf09a246878f67a4"
75 }
76 ],
77 "totalCount": 2
78}