Observação
Grupos e projetos são termos sinônimos. Seu {PROJECT-ID} é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. Esta página usa o termo grupo, que é mais familiar, ao se referir a descrições. O ponto de extremidade permanece conforme indicado no documento.
Quando você cria um trabalho de coleção de registro, o Ops Manager inicia um trabalho em segundo plano para baixar os registros da implantação do Ops Manager especificado. Use esse endpoint para recuperar todos os trabalhos de coleção de registro para um projeto do Ops Manager especificado.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /groups/{GROUP-ID}/logCollectionJobsParâmetros do caminho da solicitação
Nome | Tipo | necessidade | Descrição |
|---|---|---|---|
ID do grupo | string | Obrigatório | String exclusiva de 24 dígitos hexadecimais que identifica a job de solicitação de collection de registros. |
Solicitar parâmetros de query
Nome | Tipo | necessidade | Descrição | Default |
|---|---|---|---|---|
pageNum | número | Opcional | Um inteiro baseado que retorna uma subseção de resultados. |
|
itemsPerPage | número | Opcional | Número de itens a serem devolvidos por página, até um máximo de 500. |
|
pretty | booleano | Opcional | Sinalizador que indica se o corpo da resposta deve estar em um formato de impressão bonita. |
|
envelope | booleano | Opcional | Sinalizador que indica se deseja ou não envolver a resposta em um envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, configure Para endpoints que retornam uma lista de resultados, o objeto |
|
verbose | Boolean | Opcional | Sinalizador que indica se todas as tarefas filhos devem ser incluídos na resposta. Cada trabalho de coleção de registro contém trabalhos filhos para cada tipo de registro e processo MongoDB incluído na solicitação. |
|
Parâmetros do corpo da solicitação
Este endpoint não usa parâmetros do corpo da solicitação HTTP.
Resposta
documento de resposta
O documento JSON de resposta inclui uma array de objetos de result, uma array de objetos de link e uma contagem do número total de objetos de result recuperados.
Nome | Tipo | Descrição |
|---|---|---|
| array | A array inclui um objeto para cada item detalhado na seção |
| array | A array inclui um ou mais links para sub-recursos e/ou recursos relacionados. As relações entre URLs são explicadas na Especificação de links da web. |
| número | Contagem de números inteiros do número total de itens no conjunto de resultados. Pode ser maior que o número de objetos na array results se todo o conjunto de resultados for paginado. |
results documento incorporado
Cada resultado é uma collection de tarefa de registro.
Nome | Tipo | Descrição |
|---|---|---|
childJobs | array | Lista de tarefa filhos associados a esta solicitação. Incluído na resposta se você configurar o parâmetro de query detalhado para |
clientJobs[n].errorMessage | string | Mensagem de erro mostrando por que essa tarefa filho falhou, se aplicável. |
childJobs[n].finishDate | string | Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando essa tarefa filho foi concluída. |
clientJobs[n].hostName | string | Nome do host de quem a tarefa filho coleta os logs. |
clientJobs[n].logCollectionType | string | Tipo de registro que esta tarefa filho coleta. Retorna um dos seguintes valores:
|
clientJobs[n].path | string | Caminho para o processo no sistema para o qual essa tarefa filha coleta registros. O MongoDB Atlas utiliza esses caminhos para construir a hierarquia de diretório no arquivo compactado.
|
clientJobs[n].startDate | string | Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando essa tarefa filho foi iniciada. |
clientJobs[n].status | string | Status desta tarefa filho. Este recurso retorna um dos seguintes valores:
|
clientJobs[n].uncompressedDiskspaceBytes | número | Espaço total em disco descompactado em bytes que esta tarefa filho utiliza. |
creationDate | string | Timestamp, no número de segundos decorridos desde a época do UNIX em que você criou o tarefa de solicitação de collection de registro. |
Data de expiração | string | Registro de data/hora, no número de segundos decorridos desde a UNIX epoch quando a tarefa de solicitação de collection de registro expira. |
groupId | string | 24única - string de dígitos hexadecimais que identifica o projeto associado à solicitação de coleção de registro. |
id | string | String exclusiva de 24 dígitos hexadecimais que identifica a job de solicitação de collection de registros. |
logTypes | array | Lista de tipos de registro incluídos nesta solicitação. Este recurso retorna um ou mais dos seguintes valores:
|
editado | booleano | Sinalizador que indica se a solicitação substitui e-mails, nomes de host, endereços IP e namespaces na resposta por valores de string aleatórios. |
Nome do recurso | string | Nome do recurso para o qual você solicitou registros. |
recursoType | string | Tipo de recurso para o qual você solicitou registros. Este recurso retorna um dos seguintes valores:
|
rootResourceName | string | Nome da implantação completa se você fez a solicitação de registro para uma parte de uma implantação. Parte da implantação pode ser um conjunto de réplicas em um cluster ou um fragmento de um cluster fragmentado. |
rootResourceType | string | Tipo da parte do sistema completo se você fez a solicitação de registro para uma parte de um sistema. Parte da implantação pode ser um conjunto de réplicas em um cluster ou um fragmento de um cluster fragmentado. Este recurso retorna um dos seguintes valores:
|
Status | string | Status da tarefa de solicitação de coleção de registro. Este recurso retorna um dos seguintes valores:
|
sizeRequestedPerFileBytes | número | Tamanho de cada arquivo de log em bytes. |
uncompressedSizeTotalBytes | número | Tamanho total descompactado dos dados de registro em bytes que essa solicitação retorna. |
ID do usuário | string | String exclusiva de 24 dígitos hexadecimais que identifica o usuário que executa a solicitação. |
downloadUrl | string | Endereço de Internet do qual você baixa os registros desta solicitação. |
Exemplo de solicitação
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs?verbose=true&pretty=true"Exemplo de resposta
Cabeçalho de resposta
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-aliveHTTP/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}Corpo de resposta
{ "links": [ { "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs?verbose=true&pageNum=1&itemsPerPage=100", "rel": "self" } ], "results": [ { "childJobs": [ { "automationAgentId": "5c810cc4ff7a256345ff97bf", "errorMessage": null, "finishDate": "2019-03-07T12:21:30Z", "hostName": "server1.example.com", "logCollectionType": "AUTOMATION_AGENT", "path": "server1.example.com/automation_agent", "startDate": "2019-03-07T12:21:24Z", "status": "SUCCESS", "uncompressedDiskSpaceBytes": 14686 } ], "creationDate": "2019-03-07T12:21:24Z", "downloadUrl": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs/5c810cc4ff7a256345ff97b7/download", "expirationDate": "2019-04-06T12:21:24Z", "groupId": "5c8100bcf2a30b12ff88258f", "id": "5c810cc4ff7a256345ff97b7", "logTypes": [ "AUTOMATION_AGENT", "MONGODB" ], "redacted": true, "resourceName": "myReplicaSet", "resourceType": "replicaset", "rootResourceName": "myReplicaSet", "rootResourceType": "replicaset", "sizeRequestedPerFileBytes": 1000, "status": "SUCCESS", "uncompressedSizeTotalBytes": 63326, "userId": "5c80f75fcf09a246878f67a4" }, { "childJobs": [ { "automationAgentId": "5c81086e014b76a3d85e1117", "errorMessage": null, "finishDate": "2019-03-07T12:02:57Z", "hostName": "server1.example.com:27027", "logCollectionType": "MONGODB", "path": "server1.example.com/27027/mongodb", "startDate": "2019-03-07T12:02:54Z", "status": "SUCCESS", "uncompressedDiskSpaceBytes": 9292 } ], "creationDate": "2019-03-07T12:02:54Z", "downloadUrl": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs/5c81086e014b76a3d85e1113/download", "expirationDate": "2019-05-06T12:02:54Z", "groupId": "5c8100bcf2a30b12ff88258f", "id": "5c81086e014b76a3d85e1113", "logTypes": [ "MONGODB", "FTDC", "AUTOMATION_AGENT" ], "redacted": false, "resourceName": "myReplicaSet", "resourceType": "replicaset", "rootResourceName": "myReplicaSet", "rootResourceType": "replicaset", "sizeRequestedPerFileBytes": 1000, "status": "IN_PROGRESS", "uncompressedSizeTotalBytes": 44518, "userId": "5c80f75fcf09a246878f67a4" } ], "totalCount": 2}