Obter um arquivo de diagnóstico de projeto

Nesta página

Funções obrigatórias

Resource
Parâmetros do caminho da solicitação
Solicitar parâmetros de query
Parâmetros do corpo da solicitação
Resposta
Exemplo de solicitação
Exemplo de resposta
Cabeçalho de resposta
Corpo de resposta

Os engenheiros do MongoDB podem solicitar que os administradores do Ops Manager forneçam arquivos de diagnóstico para um projeto para depuração e solução de problemas. Os arquivos de diagnóstico do projeto também contêm informações do sistema global sobre o Ops Manager.

Funções obrigatórias

A chave de API requer a função Global Monitoring Admin ou Global Owner para baixar um arquivo de diagnóstico.

Resource

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

GET /groups/{PROJECT-ID}/diagnostics

Parâmetros do caminho da solicitação

Nome	Tipo	necessidade	Descrição
`PROJECT-ID`	string	Obrigatório	Identificador único do projeto que possui o arquivo de diagnóstico.

Solicitar parâmetros de query

Forneça qualquer um dos seguintes parâmetros de query necessários:

Nome	Tipo	necessidade	Descrição	Default
pageNum	número	Opcional	Um inteiro baseado que retorna uma subseção de resultados.	`1`
itemsPerPage	número	Opcional	Número de itens a serem devolvidos por página, até um máximo de 500.	`100`
pretty	booleano	Opcional	Sinalizador que indica se o corpo da resposta deve estar em um prettyprint formato.	`false`
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 `envelope : true` na consulta. Para endpoints que retornam uma lista de resultados, o objeto `content` é um envelope. O Ops Manager adiciona o campo `status` ao corpo da resposta.	`false`

limite de idade	inteiro	Opcional	Duração do tempo em dias para recuperar entradas do arquivo de diagnóstico.	7
limit	inteiro	Opcional	Número máximo de entradas para o arquivo de diagnóstico.	1000
minutos	inteiro	Opcional	Faixa de tempo do arquivo de diagnóstico, começando no número especificado de minutos no passado e terminando no momento. Por exemplo, para recuperar um arquivo de diagnóstico com dados dos últimos 10 minutos, especifique `minutes=10` em sua solicitação.	1440
Limite de tamanho	inteiro	Opcional	Tamanho máximo de cada arquivo no arquivo de diagnóstico expresso no número de caracteres. Isso inclui valores até o valor inteiro mais próximo desse limite.	50000000

Parâmetros do corpo da solicitação

Este endpoint não usa parâmetros do corpo da solicitação HTTP.

Resposta

Esse endpoint retorna um arquivo compactado (.tar.gz) para o seu diretório de trabalho atual com o nome que você especificou utilizando a opção --output ou -o .

Exemplo de solicitação

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/gzip" \
     --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/diagnostics?pretty=true" \
     --output project_diagnostics.tar.gz

A resposta salva project_diagnostics.tar.gz no seu diretório de trabalho atual no seu host local.

Exemplo de resposta

Cabeçalho de resposta

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}

Corpo de resposta

Esse endpoint retorna um arquivo compactado (.tar.gz) para o seu diretório de trabalho atual com o nome que você especificou utilizando a opção --output ou -o .

Voltar

Uso do servidor

Obter arquivo de relatórios de uso global