Retornar nomes de métricas

Nesta página

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

O Cloud Manager não oferecerá mais suporte para Automação, Backup e Monitoramento do MongoDB 3.6 e 4.0 após 30 de agosto de 2024. Faça upgrade da sua versão do MongoDB ou migre para o Atlas.

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 .

Retornar todos os nomes de métricas de latência de query disponíveis e suas respectivas unidades para o projeto especificado no momento da solicitação.

URL base: https://cloud.mongodb.com/api/public/v1.0

Resource

GET /groups/{PROJECT-ID}/collStats/metrics

Parâmetros do caminho da solicitação

Parâmetro	Tipo	Descrição
ID do projeto	string	(Obrigatório.) Sequência única de 24dígitos string que identifica o projeto.

Solicitar parâmetros de query

Todos os parâmetros são opcionais.

Nome	Tipo	Descrição	Default
pretty	booleano	Indica se o corpo da resposta deve estar em um prettyprint formato.	`false`
envelope	booleano	Indica se deseja ou não envolver a resposta em um envelope.	`false`

Parâmetros do corpo da solicitação

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

Resposta

Nome	Tipo	Descrição
groupId	string	String única de 24 dígitos hexadecimais que identifica o projeto.
metrics	array	Lista que contém todos os nomes de métricas de latência de query disponíveis e suas respectivas unidades para o projeto especificado no momento da solicitação.

Exemplo de solicitação

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
 --header 'Accept: application/json' \
 --include \
 --request GET 'https://{CLOUD-MANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/collStats/metrics?pretty=true'

Exemplo de resposta

Cabeçalho de resposta

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

{
  "groupId": "{PROJECT-ID}",
  "metrics": [
    {
      "metricName": "READS_OPS",
      "units": "SCALAR_PER_SECOND"
    },
    {
      "metricName": "READS_LATENCY",
      "units": "MICROSECONDS_PER_SECOND"
    },
    {
      "metricName": "AVERAGE_READS_LATENCY",
      "units": "MICROSECONDS"
    },
    {
      "metricName": "READS_P50_VALUE",
      "units": "MICROSECONDS"
    },
    {
      "metricName": "READS_P95_VALUE",
      "units": "MICROSECONDS"
    },
    {
      "metricName": "READS_P99_VALUE",
      "units": "MICROSECONDS"
    },
    {
      "metricName": "WRITES_OPS",
      "units": "SCALAR_PER_SECOND"
    },
    {
      "metricName": "WRITES_LATENCY",
      "units": "MICROSECONDS_PER_SECOND"
    },
    {
      "metricName": "AVERAGE_WRITES_LATENCY",
      "units": "MICROSECONDS"
    },
    {
      "metricName": "WRITES_P50_VALUE",
      "units": "MICROSECONDS"
    },
    {
      "metricName": "WRITES_P95_VALUE",
      "units": "MICROSECONDS"
    },
    {
      "metricName": "WRITES_P99_VALUE",
      "units": "MICROSECONDS"
    },
    {
      "metricName": "COMMANDS_OPS",
      "units": "SCALAR_PER_SECOND"
    },
    {
      "metricName": "COMMANDS_LATENCY",
      "units": "MICROSECONDS_PER_SECOND"
    },
    {
      "metricName": "AVERAGE_COMMANDS_LATENCY",
      "units": "MICROSECONDS"
    },
    {
      "metricName": "COMMANDS_P50_VALUE",
      "units": "MICROSECONDS"
    },
    {
      "metricName": "COMMANDS_P95_VALUE",
      "units": "MICROSECONDS"
    },
    {
      "metricName": "COMMANDS_P99_VALUE",
      "units": "MICROSECONDS"
    },
    {
      "metricName": "TOTAL_OPS",
      "units": "SCALAR_PER_SECOND"
    },
    {
      "metricName": "TOTAL_LATENCY",
      "units": "MICROSECONDS_PER_SECOND"
    },
    {
      "metricName": "AVERAGE_TOTAL_OPS_LATENCY",
      "units": "MICROSECONDS"
    },
    {
      "metricName": "TOTAL_OPS_P50_VALUE",
      "units": "MICROSECONDS"
    },
    {
      "metricName": "TOTAL_OPS_P95_VALUE",
      "units": "MICROSECONDS"
    },
    {
      "metricName": "TOTAL_OPS_P99_VALUE",
      "units": "MICROSECONDS"
    }
  ]
}

Voltar

Latência da query

Pin Namespaces