/ /

/ /

Reconocer una alerta

Cloud Manager dejará de ofrecer compatibilidad con automatización, copias de seguridad y monitorización para MongoDB 3.6 y 4.0 a partir del 30de agosto de 2024. Por favor, Actualice su implementación de MongoDB o migre a Atlas.

Nota

Grupos y proyectos son términos sinónimos. Tu {PROJECT-ID} Es el mismo que el ID de tu proyecto. Para los grupos existentes, el ID de tu grupo/proyecto permanece igual. Esta página utiliza el término "grupo" para las descripciones. El punto final se mantiene como se indica en el documento.

Resource

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

PATCH /groups/{PROJECT-ID}/alerts/{ALERT-ID}

Parámetros de la ruta de solicitud

Parameter	Tipo	Necesidad	Descripción
`PROJECT-ID`	string	Requerido	Identificador único del proyecto en el que se establece esta alerta.
`ALERT-ID`	string	Requerido	Identificador único para la Alerta.

Parámetros de consulta de solicitud

Los siguientes parámetros de consulta son opcionales:

Nombre

Tipo

Necesidad

Descripción

predeterminado

bonita

booleano

Opcional

Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint formato.

false

envolvente

booleano

Opcional

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

Algunos Los clientes de laAPI no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure envelope=true en la consulta.

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

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

false

Parámetros del cuerpo de la solicitud

Campo	Tipo	Necesidad	Descripción
`acknowledged` `Until`	string	Condicional	Marca de tiempo en formato ISO 8601 fecha y hora en UTC hasta la cual se debe reconocer la alerta. Para confirmar una alerta "permanentemente", configure el valor del campo con un número elevado de años en el futuro. Se recomienda configurarlo con 100 años en el futuro. Para anular el reconocimiento de una alerta reconocida, elimine este parámetro de su solicitud.
`acknowledgement` `Comment`	string	Opcional	Descripción textual del motivo de este reconocimiento. Cloud Manager muestra el comentario junto al mensaje que indica que se ha reconocido la alerta.

Respuesta

Los campos del documento de devolución dependen del tipo de alerta:

Nombre	Tipo	Descripción
`acknowledged` `Until`	string	Marca de tiempo en formato ISO 8601 fecha y hora en UTC hasta la cual se ha reconocido la alerta. Cloud Manager devuelve este valor si se ha reconocido la alerta.
`acknowledgement` `Comment`	string	Comentario dejado por el usuario que reconoció la alerta. Cloud Manager devuelve este valor si se ha reconocido la alerta.
`acknowledging` `Username`	string	Nombre de usuario del usuario que reconoció la alerta. Cloud Manager devuelve este valor si se ha reconocido la alerta.
`alertConfigId`	string	Identificador único para la configuración de alerta que activó esta alerta.
`clusterId`	string	Identificador único del clúster al que se aplica esta alerta. Cloud Manager devuelve este valor si `"eventTypeName" : "SHARDED_CLUSTER"`
`clusterName`	string	Nombre del clúster al que se aplica esta alerta. Cloud Manager devuelve este valor si `"eventTypeName" : "SHARDED_CLUSTER"`
`created`	string	Marca de tiempo en formato ISO 8601 fecha y hora en UTC cuando se abrió la alerta.
`currentValue`	Objeto	Valor actual de la métrica que activó la alerta. Cloud Manager devuelve este valor si `"eventTypeName" : "OUTSIDE_METRIC_THRESHOLD"`.
`currentValue` `.number`	Número	Valor de la métrica.
`currentValue` `.units`	string	Unidades para el valor. El valor depende del tipo de métrica. Por ejemplo, una métrica que mide el consumo de memoria tendría una medida de byte, mientras que una métrica que mide el tiempo tendría una unidad de tiempo. Cloud Manager puede devolver: `RAW` `BITS` `BYTES` `KILOBITS` `KILOBYTES` `MEGABITS` `MEGABYTES` `GIGABITS` `GIGABYTES` `TERABYTES` `PETABYTES` `MILLISECONDS` `SECONDS` `MINUTES` `HOURS` `DAYS`
`eventTypeName`	string	Nombre del evento que activó la alerta. Los valores aceptados son: Agente `AUTOMATION_AGENT_DOWN` `AUTOMATION_AGENT_UP` `BACKUP_AGENT_CONF_CALL_FAILURE` `BACKUP_AGENT_DOWN` `BACKUP_AGENT_UP` `BACKUP_AGENT_VERSION_BEHIND` `BACKUP_AGENT_VERSION_CURRENT` `MONITORING_AGENT_DOWN` `MONITORING_AGENT_UP` `MONITORING_AGENT_VERSION_BEHIND` `MONITORING_AGENT_VERSION_CURRENT` `NEW_AGENT` Configuración de automatización `AUTOMATION_CONFIG_PUBLISHED_AUDIT` Backup `BAD_CLUSTERSHOTS` `CLUSTER_DENYLIST_UPDATED_AUDIT` `CLUSTER_CHECKKPOINT_UPDATED_AUDIT` `CLUSTER_CREDENTIAL_UPDATED_AUDIT` `CLUSTER_SNAPSHOT_SCHEDULE_UPDATED_AUDIT` `CLUSTER_STATE_CHANGED_AUDIT` `CLUSTER_STORAGE_ENGINE_UPDATED_AUDIT` `CLUSTERSHOT_DELETED_AUDIT` `CLUSTERSHOT_EXPIRY_UPDATED_AUDIT` `CONSISTENT_BACKUP_CONFIGURATION` `GOOD_CLUSTERSHOT` `INCONSISTENT_BACKUP_CONFIGURATION` `INITIAL_SYNC_FINISHED_AUDIT` `INITIAL_SYNC_STARTED_AUDIT` `OPLOG_BEHIND` `OPLOG_CURRENT` `RESTORE_REQUESTED_AUDIT` `RESYNC_PERFORMED` `RESYNC_REQUIRED` `RS_DENYLIST_UPDATED_AUDIT` `RS_CREDENTIAL_UPDATED_AUDIT` `RS_ROTATE_MASTER_KEY_AUDIT` `RS_SNAPSHOT_SCHEDULE_UPDATED_AUDIT` `RS_STATE_CHANGED_AUDIT` `RS_STORAGE_ENGINE_UPDATED_AUDIT` `SNAPSHOT_DELETED_AUDIT` `SNAPSHOT_EXPIRY_UPDATED_AUDIT` `SYNC_PENDING_AUDIT` `SYNC_REQUIRED_AUDIT` Conector de BI `BI_CONNECTOR_DOWN` `BI_CONNECTOR_UP` Facturación `ACCOUNT_DOWNGRADED` `ACCOUNT_UPGRADED` `CHARGE_FAILED` `CHARGE_SUCCEEDED` `CHECK_PAYMENT_RECEIVED` `CREDIT_CARD_ABOUT_TO_EXPIRE` `CREDIT_CARD_CURRENT` `CREDIT_ISSUED` `DAILY_BILL_OVER_THRESHOLD` `DAILY_BILL_UNDER_THRESHOLD` `DISCOUNT_APPLIED` `INVOICE_ADDRESS_ADDED` `INVOICE_ADDRESS_CHANGED` `INVOICE_CLOSED` `PAYMENT_FORGIVEN` `PENDING_INVOICE_OVER_THRESHOLD` `PENDING_INVOICE_UNDER_THRESHOLD` `PREPAID_PLAN_ACTIVATED` `PROMO_CODE_APPLIED` `REFUND_ISSUED` `STALE_PENDING_INVOICES` `WIRE_TRANSFER_PAYMENT_RECEIVED` Clúster `CLUSTER_MONGOS_IS_MISSING` `CLUSTER_MONGOS_IS_PRESENT` `SHARD_ADDED` `SHARD_REMOVED` Explorador de datos accedido `DATA_EXPLORER` `DATA_EXPLORER_CRUD` Copia de seguridad de disco `CPS_RESTORE_REQUESTED_AUDIT` Host `ATTEMPT_KILLOP_AUDIT` `ATTEMPT_KILLSESSION_AUDIT` `DB_PROFILER_DISABLE_AUDIT` `DB_PROFILER_ENABLE_AUDIT` `DISABLE_HOST_AUDIT` `HIDE_AND_DISABLE_HOST_AUDIT` `HIDE_HOST_AUDIT` `HOST_DOWN` `HOST_DOWNGRADED` `HOST_EXPOSED` `HOST_IP_CHANGED_AUDIT` `HOST_LOCKED_DOWN` `HOST_NOW_PRIMARY` `HOST_NOW_SECONDARY` `HOST_NOW_STANDALONE` `HOST_RECOVERED` `HOST_RECOVERING` `HOST_SECURITY_CHECKUP_NOT_MET` `HOST_SSL_CERTIFICATE_CURRENT` `HOST_SSL_CERTIFICATE_STALE` `HOST_UP` `HOST_UPGRADED` `INSIDE_METRIC_THRESHOLD` `NEW_HOST` `OUTSIDE_METRIC_THRESHOLD` `PAUSE_HOST_AUDIT` `RESUME_HOST_AUDIT` `UNDELETE_HOST_AUDIT` `VERSION_BEHIND` `VERSION_CHANGED` `VERSION_CURRENT` Organización `ALL_ORG_USERS_HAVE_MFA` `ORG_ACTIVATED` `ORG_ADMIN_SUSPENDED` `ORG_API_KEY_ADDED` `ORG_API_KEY_DELETED` `ORG_CREDIT_CARD_ABOUT_TO_EXPIRE` `ORG_CREDIT_CARD_ADDED` `ORG_CREDIT_CARD_CURRENT` `ORG_CREDIT_CARD_UPDATED` `ORG_DAILY_BILL_OVER_THRESHOLD` `ORG_DAILY_BILL_UNDER_THRESHOLD` `ORG_EMPLOYEE_ACCESS_RESTRICTED` `ORG_EMPLOYEE_ACCESS_UNRESTRICTED` `ORG_GROUP_CHARGES_OVER_THRESHOLD` `ORG_GROUP_CHARGES_UNDER_THRESHOLD` `ORG_INVOICE_OVER_THRESHOLD` `ORG_INVOICE_UNDER_THRESHOLD` `ORG_LOCKED` `ORG_PUBLIC_API_ACCESS_LIST_NOT_REQUIRED` `ORG_PUBLIC_API_ACCESS_LIST_REQUIRED` `ORG_RENAMED` `ORG_SUSPENDED` `ORG_TEMPORARILY_ACTIVATED` `ORG_TWO_FACTOR_AUTH_OPTIONAL` `ORG_TWO_FACTOR_AUTH_REQUIRED` `ORG_USERS_WITHOUT_MFA` Proyecto `ALL_USERS_HAVE_MULTI_FACTOR_AUTH` `DELINQUENT` `PAID_IN_FULL` `USERS_WITHOUT_MULTI_FACTOR_AUTH` Set de réplicas `CONFIGURATION_CHANGED` `ENOUGH_HEALTHY_MEMBERS` `MEMBER_ADDED` `MEMBER_REMOVED` `MULTIPLE_PRIMARIES` `NO_PRIMARY` `ONE_PRIMARY` `TOO_FEW_HEALTHY_MEMBERS` `TOO_MANY_ELECTIONS` `TOO_MANY_UNHEALTHY_MEMBERS` Caso de soporte `CASE_CREATED` Equipo `TEAM_ADDED_TO_GROUP` `TEAM_CREATED` `TEAM_DELETED` `TEAM_NAME_CHANGED` `TEAM_REMOVED_FROM_GROUP` `TEAM_ROLES_MODIFIED` `TEAM_UPDATED` `USER_ADDED_TO_TEAM` Usuario `INVITED_TO_GROUP` `INVITED_TO_ORG` `JOIN_GROUP_REQUEST_APPROVED_AUDIT` `JOIN_GROUP_REQUEST_DENIED_AUDIT` `JOINED_TEAM` `REMOVED_FROM_GROUP` `REMOVED_FROM_ORG` `REMOVED_FROM_TEAM` `REQUESTED_TO_JOIN_GROUP`
`groupId`	string	Identificador único del grupo para el que se abrió esta alerta.
`hostId`	string	Identificador único del host al que pertenece la métrica. Cloud Manager devuelve este valor si `"eventTypeName"` se configuró en uno de los siguientes: `HOST_DOWN` `OUTSIDE_METRIC_THRESHOLD` `REPLICA_SET`
`hostnameAndPort`	string	Nombre de host y puerto de cada host al que se aplica la alerta. Puede ser un nombre de host, un FQDN, una dirección IPv o4 una dirección IPv.6 Cloud Manager devuelve este valor si `"eventTypeName"` se configuró en uno de los siguientes: `HOST_DOWN` `OUTSIDE_METRIC_THRESHOLD` `REPLICA_SET`
`id`	string	Identificador único para la alerta.
`lastNotified`	string	Marca de tiempo en formato ISO 8601 de fecha y hora UTC del último envío de notificaciones para esta alerta. Cloud Manager devuelve este valor si se enviaron notificaciones.
`links`	matriz de objetos	Uno o más enlaces a subrecursos o recursos relacionados. Todas las `links` matrices en las respuestas incluyen al menos un enlace `self` llamado. Las relaciones entre las URLse explican en la Especificación de Enlaces Web.
`metricName`	string	Nombre de la medida cuyo valor salió del umbral. Cloud Manager devuelve este valor si `"eventTypeName"` se estableció en `OUTSIDE_METRIC_THRESHOLD`. Para conocer los valores posibles, consulte Tipos de medición para alertas.
`replicaSetName`	string	Nombre del conjunto de réplicas. Cloud Manager devuelve este valor si `"eventTypeName"` se configuró en uno de los siguientes: `BACKUP` `HOST_DOWN` `OUTSIDE_METRIC_THRESHOLD` `REPLICA_SET`
`resolved`	string	Marca de tiempo en formato ISO 8601 fecha y hora en UTC cuando se cerró la alerta. Cloud Manager devuelve este valor si `"status" : "CLOSED"`.
`status`	string	Estado actual de la alerta. Cloud Manager puede devolver uno de los siguientes: `TRACKING` La condición de alerta existe, pero no ha persistido más allá del plazo de notificación definido. Para más detalles, consulte Parámetros de consulta de solicitud. `OPEN` `CLOSED` `CANCELLED`
`sourceTypeName`	string	Tipo de host del que se realiza la copia de seguridad cuando `"eventTypeName" : "BACKUP"`. Cloud Manager puede devolver uno de los siguientes valores: `REPLICA_SET` `SHARDED_CLUSTER` `CONFIG_SERVER`
`tags`	matriz de cadenas	Etiquetas de identificación establecidas para esta alerta.
`typeName`	string	Campo obsoleto. \|mms\| lo ignora.
`updated`	string	Marca de tiempo en formato ISO 8601 de fecha y hora en UTC cuando se actualizó la alerta por última vez.

Ejemplo de solicitud

1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2      --header "Accept: application/json" \
3      --header "Content-Type: application/json" \
4      --include \
5      --request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/alerts/{ALERT-CONFIG-ID}"
6      --data '
7        {
8          "acknowledgedUntil": "2016-04-15T00:00:00-0400",
9          "acknowledgementComment": "This is normal. Please ignore."
10        }'

Ejemplo de respuesta

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}

Cuerpo de respuesta

1 {
2   "id" : "{ALERT-CONFIG-ID}",
3   "groupId" : "{PROJECT-ID}",
4   "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD",
5   "status" : "OPEN",
6   "acknowledgedUntil" : "2014-04-15T04:00:00Z",
7   "acknowledgementComment" : "This is normal. Please ignore.",
8   "acknowledgingUsername" : "someuser@example.com",
9   "created" : "2014-04-03T20:28:14Z",
10   "updated" : "2014-04-03T20:33:14Z",
11   "lastNotified" : "2014-04-03T20:33:23Z",
12   "metricName": "ASSERTS_REGULAR",
13   "currentValue" : {
14     "number" : 0.0,
15     "units" : "RAW"
16   },
17   "links" : []
18 }

Volver

Recibe una alerta

Configuraciones de alertas

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--include \
5	--request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/alerts/{ALERT-CONFIG-ID}"
6	--data '
7	{
8	"acknowledgedUntil": "2016-04-15T00:00:00-0400",
9	"acknowledgementComment": "This is normal. Please ignore."
10	}'

1	{
2	"id" : "{ALERT-CONFIG-ID}",
3	"groupId" : "{PROJECT-ID}",
4	"eventTypeName" : "OUTSIDE_METRIC_THRESHOLD",
5	"status" : "OPEN",
6	"acknowledgedUntil" : "2014-04-15T04:00:00Z",
7	"acknowledgementComment" : "This is normal. Please ignore.",
8	"acknowledgingUsername" : "someuser@example.com",
9	"created" : "2014-04-03T20:28:14Z",
10	"updated" : "2014-04-03T20:33:14Z",
11	"lastNotified" : "2014-04-03T20:33:23Z",
12	"metricName": "ASSERTS_REGULAR",
13	"currentValue" : {
14	"number" : 0.0,
15	"units" : "RAW"
16	},
17	"links" : []
18	}