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 recuperar todos los trabajos de recopilación de registros de un proyecto de Ops Manager específico.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /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
Nombre | Tipo | Necesidad | Descripción | predeterminado |
|---|---|---|---|---|
número de página | Número | Opcional | Entero basado en uno que devuelve una subsección de resultados. |
|
artículos por página | Número | Opcional | Número de artículos a devolver por página, hasta un máximo de 500. |
|
bonita | booleano | Opcional | Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint formato. |
|
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 Para los puntos finales que devuelven una lista de resultados, el objeto |
|
trabajos de respaldo habilitados solamente | booleano | Opcional | Indicador que indica si se deben excluir de la respuesta los daemons no habilitados para realizar copias de seguridad de bases de datos. Establezca este valor en |
|
verbose | Booleano | Opcional | Marca que indica si se deben incluir todos los trabajos secundarios en la respuesta. Cada trabajo de recopilación de registros contiene trabajos secundarios para cada tipo de registro y proceso de MongoDB incluido en la solicitud. |
|
Parámetros del cuerpo de la solicitud
Este punto final no utiliza parámetros del cuerpo de la solicitud HTTP.
Respuesta
Documento de respuesta
El documento JSON de respuesta incluye una matriz de result objetos, una matriz de link objetos y un recuento del número total de result objetos recuperados.
Nombre | Tipo | Descripción |
|---|---|---|
| arreglo | La matriz incluye un objeto para cada elemento detallado en el
Sección |
| arreglo | La matriz incluye uno o más enlaces a subrecursos o recursos relacionados. Las relaciones entre las URLse explican en la Especificación de Enlaces Web. |
| Número | Número entero del número total de elementos en el conjunto de resultados. Puede ser mayor que el número de objetos en la matriz results si todo el conjunto de resultados está paginado. |
results Documento incrustado
Cada resultado equivale en si a una tarea de recopilación de registros.
Nombre | Tipo | Descripción | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
trabajos infantiles | arreglo | Lista de trabajos secundarios asociados a esta solicitud. Se incluye en la respuesta si se establece el parámetro de consulta verbosa | ||||||||||||
childJobs[n].mensajeDeError | string | Mensaje de error que muestra por qué falló este trabajo secundario, si corresponde. | ||||||||||||
childJobs[n].fechaDeFin | string | Marca de tiempo en formato ISO 8601 de fecha y hora en UTC cuando finalizó este trabajo secundario. | ||||||||||||
trabajos secundarios[n].nombrehost | string | Nombre del host desde el cual el trabajo secundario recopila los registros. | ||||||||||||
childJobs[n].logCollectionType | string | Tipo de registro que recopila este trabajo secundario. Devuelve uno de los siguientes valores:
| ||||||||||||
childJobs[n].path | string | Ruta al proceso en la implementación para el cual este trabajo secundario recopila registros. MongoDB Atlas utiliza estas rutas para crear la jerarquía de directorios en el archivo comprimido.
| ||||||||||||
childJobs[n].fechadeinicio | string | Marca de tiempo en formato ISO,8601 fecha y hora en UTC cuando se inició este trabajo secundario. | ||||||||||||
childJobs[n].status | string | Estado de este trabajo secundario. Este recurso devuelve uno de los siguientes valores:
| ||||||||||||
childJobs[n].bytesdeespaciodediscosincomprimir | Número | Espacio total en disco sin comprimir en bytes que utiliza este trabajo secundario. | ||||||||||||
fecha de creación | string | Marca de tiempo, en la cantidad de segundos que han transcurrido desde la época de UNIX en la que creó el trabajo de solicitud de recopilación de registros. | ||||||||||||
expirationDate | string | Marca de tiempo, en la cantidad de segundos que han transcurrido desde la época de UNIX en la que expira el trabajo de solicitud de recopilación de registros. | ||||||||||||
ID de grupo | string | Cadena 24de dígitos hexadecimales única que identifica el proyecto asociado con la solicitud de recopilación de registros. | ||||||||||||
ID. | string | Cadena de dígitos hexadecimales 24única que identifica el trabajo de solicitud de recopilación de registros. | ||||||||||||
tipos de registro | arreglo | Lista de tipos de registro incluidos en esta solicitud. Este recurso devuelve uno o más de los siguientes valores:
| ||||||||||||
redactado | booleano | Bandera que indica si la solicitud reemplaza correos electrónicos, nombres de host, direcciones IP y espacios de nombres en la respuesta con valores de cadena aleatorios. | ||||||||||||
nombreRecurso | string | Nombre del recurso para el que solicitó registros. | ||||||||||||
tipo de recurso | string | Tipo de recurso para el que se solicitaron los registros. Este recurso devuelve uno de los siguientes valores:
| ||||||||||||
nombreDeRecursoRaíz | string | Nombre de la implementación completa si se realizó la solicitud de registro a una parte de la implementación. Esta parte podría ser un conjunto de réplicas en un clúster o un fragmento de un clúster fragmentado. | ||||||||||||
rootResourceType | string | Tipo de la parte de la implementación completa si se realizó la solicitud de registro a una parte de la implementación. Una parte de la implementación podría ser un conjunto de réplicas en un clúster o un fragmento de un clúster fragmentado. Este recurso devuelve uno de los siguientes valores:
| ||||||||||||
Estado | string | Estado de la solicitud de recopilación de registros. Este recurso devuelve uno de los siguientes valores:
| ||||||||||||
tamaño solicitado por bytes de archivo | Número | Tamaño de cada archivo de registro en bytes. | ||||||||||||
sin comprimirTamañoTotalBytes | Número | Tamaño total sin comprimir de los datos de registro en bytes que devuelve esta solicitud. | ||||||||||||
ID de usuario | string | Cadena de dígitos hexadecimales 24única que identifica al usuario que ejecuta la solicitud. | ||||||||||||
URL de descarga | string | Dirección de Internet desde la que se descargan los registros de esta solicitud. |
Ejemplo de solicitud
1 curl --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"
Ejemplo de respuesta
Encabezado de respuesta
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
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}
Cuerpo de respuesta
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 }