Obter todas as tarefas de collection de registros de um projeto
Nesta página
- A autenticação OAuth 2.0 para acesso programático ao Cloud Manager está disponível como um recurso de visualização.
- O recurso e a documentação correspondente podem mudar a qualquer momento durante o período de Pré-visualização. Para usar a 2.0 autenticação OAuth, crie uma conta de serviço para usar em suas solicitações para a API pública do Cloud Manager .
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 grupo de termos mais conhecido ao se referir às descrições. O ponto final permanece conforme indicado no documento.
Quando você cria uma tarefa de collection de registros, o Cloud Manager inicia uma tarefa em segundo plano para baixar os registros da implantação do Cloud Manager especificado. Use esse endpoint para recuperar todas as tarefas de collection de registros para um projeto do Cloud Manager especificado.
URL base: https://cloud.mongodb.com/api/public/v1.0
Resource
GET /groups/{GROUP-ID}/logCollectionJobs
Parâ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 prettyprint formato. |
|
envelope | booleano | Opcional | Sinalizador que indica se deseja ou não envolver a resposta em um envelope. Alguns clientes do 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 |
|
backupJobsEnabledOnly | booleano | Opcional | Sinalizador que indica se os daemon não habilitados para reconhecimento de data center devem ser excluídos da resposta. Defina isso como |
|
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 result , uma array de objetos link e uma contagem do número total de objetos 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 secundária for 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 secundária começou. | ||||||||||||
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 | Registro de data/hora, em segundos decorridos desde a UNIX epoch quando você criou o trabalho de solicitação de collection de registro. | ||||||||||||
Data de expiração | string | Registro de data/hora, em segundos decorridos desde a UNIX epoch quando o trabalho 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. | ||||||||||||
URL | string | Endereço de Internet do qual você baixa os registros desta solicitação. | ||||||||||||
logCollectionFromDate | string | A data e a hora de início da coleta de registros na ISO 8601 formato (UTC). | ||||||||||||
logCollectionToDate | string | A data e a hora finais da collection de registros na ISO 8601 formato (UTC). |
Exemplo de solicitação
1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ 2 --header "Accept: application/json" \ 3 --include \ 4 --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs?verbose=true&pretty=true"
Exemplo de resposta
Cabeçalho de resposta
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}
Corpo de resposta
1 { 2 "links": [ 3 { 4 "href": "https://cloud.mongodb.com/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://cloud.mongodb.com/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://cloud.mongodb.com/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 }