/ /

Mediciones y alertas

Configuraciones de Alerta

Configuraciones de Alerta

Obtener todos los nombres de campo de Alert Configuration Matchers

Nota

Grupos y proyectos son términos sinónimos. Tu {PROJECT-ID} es el mismo que el ID del grupo. Para los grupos existentes, el ID del grupo permanece igual. Esta página utiliza el término grupo, más familiar, cuando se refiere a descripciones. El endpoint sigue siendo el declarado en el documento.

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

Obtén todos los nombres de campos que acepta el parámetro matchers.fieldName al crear o actualizar una configuración de alertas.

Roles necesarios

Puedes llamar eficazmente a este endpoint con cualquier rol asignado.

Solicitud

GET /alertConfigs/matchers/fieldNames

Parámetros de ruta de solicitud

Este endpoint no utiliza parámetros de ruta de solicitud HTTP.

Parámetros de Solicitud Query

Nombre

Tipo

Necesidad

Descripción

predeterminado

bonito

booleano

Opcional

Indicador que muestra si el cuerpo de la respuesta debe estar en formato prettyprint.

false

envelope

booleano

Opcional

Bandera que indica si se debe o no envolver la respuesta en un sobre.

Algunos clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, ajusta envelope=true en la query.

Para los endpoints que devuelven un resultado, el cuerpo de la respuesta incluye:

Nombre	Descripción
`status`	Código de respuesta HTTP
`content`	Cuerpo de respuesta esperado

false

Parámetros del cuerpo de la solicitud

Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.

Respuesta

La respuesta devuelve un arreglo de strings que el parámetro matchers.fieldName acepta al crear o actualizar una Configuración de Alertas.

Solicitud de ejemplo

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
     --header 'Accept: application/json' \
     --include \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/alertConfigs/matchers/fieldNames"

Respuesta de ejemplo

Encabezado de respuesta

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}

Respuesta del cuerpo

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

Volver

Configuraciones de Alerta

Obtener todo para un proyecto