Obtén todos los nombres de campos que acepta el parámetro matchers.fieldName cuando creas o actualizas una configuración de alerta. Puedes llamar a este endpoint exitosamente con cualquier rol asignado.
Parámetros de consulta
-
Indicador que indica si la aplicación encapsula la respuesta en un objeto JSON
envelope. Algunos clientes de la API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure envelope=true en la consulta. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como encapsulado. La aplicación añade el parámetro de estado al cuerpo de la respuesta.El valor predeterminado es
false. -
Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint.
El valor predeterminado es
false.Impresión bonita
Respuestas
-
Vale
Uno de: Cadena de campos del comparador de métricasde App Services Cadena de camposdel comparador de clústeres Cadena de camposde comparación de host Cadena de campos coincidentes delconjunto de réplicas Cadena de campos del comparador de secuenciasstring Cadena de campos del comparador de tipos de software globalEl valor es
APPLICATION_ID.El valor es
CLUSTER_NAME.Los valores son
TYPE_NAME,HOSTNAME,PORT,HOSTNAME_AND_PORToREPLICA_SET_NAME.Los valores son
REPLICA_SET_NAME,SHARD_NAMEoCLUSTER_NAME.Los valores son
INSTANCE_NAMEoPROCESSOR_NAME.El valor es
RULE_ID.El valor es
SOFTWARE_TYPE. -
No autorizado.
-
Forbidden.
-
Error Interno del Servidor.
atlas api alertConfigurations listMatcherFieldNames --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20250219001/admin"
)
func main() {
ctx := context.Background()
clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")
// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))
if err != nil {
log.Fatalf("Error: %v", err)
}
params = &sdk.ListAlertConfigMatcherFieldNamesApiParams{}
sdkResp, httpResp, err := client.AlertConfigurationsApi.
ListAlertConfigMatcherFieldNamesWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2025-02-19+json" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/alertConfigs/matchers/fieldNames?pretty=true"curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2025-02-19+json" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/alertConfigs/matchers/fieldNames?pretty=true"[
"APPLICATION_ID"
]{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}