Página inicial do Docs

/ /

Telemetria

Página inicial do Docs

/ /

Recursos

Telemetria

Página inicial do Docs

Retrieve Telemetry Data

Recupere o status da coleção de telemetria e os detalhes de configuração da instalação do Ops Manager.

Funções obrigatórias

Este endpoint requer uma chave de API que tenha o Global Owner papel.

Endpoint

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

GET /collection/details

Solicitar

parâmetros de caminho

Este endpoint não usa parâmetros de caminho de solicitação HTTP.

parâmetros de query

Este endpoint não usa parâmetros de query de solicitação HTTP.

Parâmetros do corpo

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

Resposta

documento de resposta

O documento JSON de resposta inclui os seguintes campos:

Nome	Tipo	Descrição
habilitado	booleano	Indica se o sistema coleta e envia telemetria.
last_successful_send	datetime	Data e hora do último envio de telemetria bem-sucedido.
próximo_job	datetime	Data e hora para o próximo envio de telemetria.
de dados	array	Array de objetos definidos no objeto incorporado Dados de telemetria.

Objeto incorporado de dados de telemetria

Cada elemento na matriz data descreve detalhes de telemetria para a instalação do Ops Manager.

Nome	Tipo	Descrição
app_db_nodes	inteiro	Número de nós do AppDB que esta instalação do Ops Manager utiliza.
uuid	string	Identificador exclusivo estático para esta instalação do Ops Manager.
os	array de strings	Sistemas operacionais executados nos hosts do Ops Manager.
Versão	string	Versão atual do Ops Manager.
instâncias	inteiro	Número de instâncias do Ops Manager nesta instalação.
backup_daemons	inteiro	Número de daemons de backup em execução nesta instalação.
auth_method	string	Método de autenticação usado pelo Ops Manager. Valores possíveis: `DB`, `LDAP` ou `SAML`.
CPU	array de números inteiros	Número de núcleos de CPU provisionados para cada host do Ops Manager.
Memória	array de números inteiros	Quantidade de memória provisionada para cada host do Ops Manager.
infra-estrutura	string	Tipo de infraestrutura que hospeda o Ops Manager. Valores possíveis: `Kubernetes`, `VM` ou `Bare Metal`.
projects	inteiro	Número total de projetos existentes atualmente.
organizações	inteiro	Número total de organizações que existem atualmente.
implantações	array	Array de objetos definidos no Objeto embarcado de Sistemas de telemetria.

Objeto incorporado de implantações de telemetria

Cada elemento na array deployments descreve uma implantação do MongoDB que o Ops Manager gerencia.

Nome	Tipo	Descrição
Versão	array de strings	Versões do MongoDB que a implantação utiliza.
uuid	string	Identificador exclusivo estático para o sistema.
tls_enabled	booleano	Indica se oTLS está habilitado para a implantação.
auth_method	string	Método de autenticação que o sistema utiliza. Valores possíveis: `MONGODB-CR`, `GSSAPI`, `PLAIN` ou `MONGODB-X509`.
type	string	Tipo de sistema. Valores possíveis: `SC`, `RS` ou `SA`.
Nós	inteiro	Número de nós no sistema se for um conjunto de réplicas.
shards	inteiro	Número de shards no sistema se for um cluster fragmentado.
data_size	inteiro	Tamanho total dos dados para o sistema, não incluindo metadados locais.
edição	objeto	Objeto que contém duas chaves, `community` e `enterprise`. Cada chave tem um valor inteiro que representa o número de nós dessa edição no sistema.

Exemplo de solicitação

curl --user "{publicApiKey}:{privateApiKey}" --digest \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --include \
  --request GET "https://<OpsManagerHost>:<Port>/api/private/v1.0/telemetry/collection/details"

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

{
  "data": {
    "app_db_nodes": 1,
    "auth_method": "DB",
    "backup_daemons": 3,
    "cpu": [
      14,12
    ],
    "infrastructure": "Bare Metal",
    "instances": 2,
    "memory": [
      "3221225472","221225472"
    ],
    "os": [
      "RHEL 8.10 aarch64","RHEL 8.11 aarch64"
    ],
    "orgs": 3,
    "projects": 12,
    "uuid": "84248c7e-94df-4a0c-942a-dfb1fa987edd",
    "version": "8.0.13",
    "deployments": [
      {
        "auth_method": "MONGODB-CR",
        "data_size": 3221225472,
        "edition": {
          "community": 3,
          "enterprise": 0
       },
        "nodes": 3,
        "tls_enabled": true,
        "type": "RS",
        "uuid": "6907dd45d61b992049366140",
        "version": [
          "8.15","7.11"
        ]
       },
       {
         "auth_method": "MONGODB-CR",
           "data_size": 221225472,
           "edition": {
             "community": 1,
             "enterprise": 2
             },
             "shards": 3,
             "tls_enabled": false,
             "type": "SC",
             "uuid": "6907de15d61b9920493664ca",
             "version": [
               "8.15"
             ]
         }
     ],
  },
  "enabled": true,
  "last_successful_send": "2025-10-02T22:26:10Z",
  "next_job": "2025-10-09T22:26:10Z"
}

Voltar

Telemetria

Alternar status de telemetria