Obter um arquivo de relatório de uso global
Nesta página
Recupere um relatório compactado, em formato zip ou .tar.gz , do uso do servidor em um determinado período de tempo.
Funções obrigatórias
Sua chave de API deve ter a função Global Owner para chamar esse recurso com êxito.
Solicitar
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
GET /usage/report
Parâmetros do caminho da solicitação
Este endpoint não usa parâmetros de caminho de solicitação HTTP.
Solicitar parâmetros de query
Nome | Tipo | necessidade | Descrição | Default | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | booleano | Opcional | Sinalizador indicando 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 da API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na query. Para endpoints que retornam um resultado, o corpo da resposta inclui:
| false |
startDate | string | Obrigatório | Data em ISO 8601 formato de data em que o relatório é iniciado. | |
endDate | string | Obrigatório | Data em ISO 8601 formato de data em que o relatório termina. | |
Formato de arquivo | String | Obrigatório | Formato de compressão do relatório resultante. O Ops Manager aceita arquivos zip ou .tar.gz . | |
redigir | Boolean | Opcional | Sinalizador que indica se a resposta deve inspecionar todos os endereços IP, nomes de host, nomes de organizações e nomes de projetos no relatório. | true |
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 .zip ou .tar.gz com base no parâmetro FileFormat .
Exemplo de solicitação
curl --user "{publicApiKey}:{privateApiKey}" --digest \ --header "Accept: application/gzip" \ --include \ --request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/usage/report?startDate=2019-07-27&endDate=2020-07-28&fileFormat=zip"
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
Esse endpoint retorna um arquivo compactado .zip ou .tar.gz com base no parâmetro FileFormat .