Obtenha todos os nomes de campo dos correspondentes de configuração de alertas

Esta versão da documentação foi arquivada e não é mais suportada. Consulte a documentação atual do para saber como atualizar sua versão do MongoDB Ops 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.

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

Obtenha todos os nomes de campo que o parâmetro matchers.fieldName aceita ao criar ou atualizar uma Configuração de Alerta.

Funções obrigatórias

Você pode chamar esse endpoint com sucesso com qualquer função atribuída.

Solicitar

GET /alertConfigs/matchers/fieldNames

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 que indica se o corpo da resposta deve estar em um formato de impressão bonita.

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:

Nome	Descrição
Status	Código de resposta HTTP
envelope	Corpo de resposta esperado

false

Parâmetros do corpo da solicitação

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

Resposta

A resposta retorna uma array de strings que o parâmetro matchers.fieldName aceita quando você cria ou atualiza uma Configuração de Alerta.

Exemplo de solicitação

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
  --header 'Accept: application/json' \
  --include \
  --request GET "https://<ops-manager-host>/api/public/v1.0/alertConfigs/matchers/fieldNames"

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

[
    "TYPE_NAME",
    "HOSTNAME",
    "PORT",
    "HOSTNAME_AND_PORT",
    "REPLICA_SET_NAME",
    "SHARD_NAME",
    "CLUSTER_NAME"
]

Voltar

Configurações de alerta

Obter tudo para um projeto