/ /

Mediciones y alertas

Configuración de integración

Docs Home

MongoDB Ops Manager

API

Recursos

Mediciones y alertas

Configuración de integración

Crear una configuración para una integración de servicios de terceros

Esta versión de la documentación está archivada y ya no se admite. Ver la Documentación actual para aprender cómo actualizar su versión de MongoDB Ops Manager.

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.

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

Sintaxis

POST /groups/{GROUP-ID}/integrations/{INTEGRATION-TYPE}

Parámetros de la ruta de solicitud

Parameter	Necesidad	Descripción
`{PROJECT-ID}`	Requerido	Identificador del proyecto.
`{INTEGRATION-TYPE}`	Requerido	Identificador de servicio de terceros. Los valores aceptados son: `DATADOG` `HIP_CHAT` `PAGER_DUTY` `SLACK` `NEW_RELIC` `OPS_GENIE` `VICTOR_OPS` `WEBHOOK`

Parámetros de consulta de solicitud

Nombre	Tipo	Necesidad	Descripción	predeterminado
número de página	Número	Opcional	Entero basado en uno que devuelve una subsección de resultados.	`1`
artículos por página	Número	Opcional	Número de artículos a devolver por página, hasta un máximo de 500.	`100`
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 una lista de resultados, el objeto `results` es un sobre. Ops Manager añade el campo `status` al cuerpo de la respuesta.	`false`
trabajos de respaldo habilitados solamente	booleano	Opcional	Indicador que indica si se deben excluir de la respuesta los daemons no habilitados para realizar copias de seguridad de bases de datos. Establezca este valor en `false` para incluir las configuraciones de daemon con el indicador `backupJobsEnabled` establecido en `false`.	`true`

Parámetros del cuerpo de la solicitud

El cuerpo de la solicitud debe ser una vista de integración única (como un objeto de configuración JSON) para que un único servicio de terceros se añada al proyecto. Incluya siempre una type propiedad igual al servicio de INTEGRATION_TYPE terceros.

Servicio

Opciones de configuración

PagerDuty

Debe proporcionar los siguientes campos cuando configure una integración de PagerDuty:

Propiedad

Descripción

type

PAGER_DUTY

serviceKey

Su clave de integración.

Importante

Cambiar la clave de integración no modifica las alertas que utilizan esta integración. Estas alertas siguen utilizando la clave de integración anterior.

Elimine y vuelva a agregar cada notificación de PagerDuty para usar la nueva clave.

PagerDuty Desactivaron su clave de API REST v1 en octubre de 2018 2019. Si tiene la1 clave v, puede seguir usándola con Ops Manager. Todas las claves nuevas de PagerDuty usan su API REST2 v, pero Ops Manager no admite sus2 claves v. Si no tiene su clave de API REST1 v, use la API de eventos de1 PagerDuty v.

Después de crear una integración de terceros que requiere una API o una clave de integración, la clave aparece parcialmente redactada cuando:

Ver o editar la alerta a través de la interfaz de usuario.
Consulta la configuración de integración de terceros a través de la API.

Slack

Importante

Las integraciones de Slack ahora utilizan el método de verificación OAuth2 y deben configurarse inicialmente o actualizarse desde una integración heredada a través de MongoDB Atlas. Página de integraciones de servicios de terceros.

Los tokens heredados pronto dejarán de ser compatibles.

Debe proporcionar los siguientes campos cuando reconfigure una integración de Slack existente:

Propiedad	Descripción
`type`	`SLACK`
`apiToken`	Su token API. Después de crear una integración de terceros que requiere una API o una clave de integración, la clave aparece parcialmente redactada cuando: Ver o editar la alerta a través de la interfaz de usuario. Consulta la configuración de integración de terceros a través de la API.
`teamName`	El nombre de tu equipo.

También puede incluir los siguientes campos:

Propiedad	Descripción
`channelName`	El nombre del canal a reconfigurar.

Datadog

Debe proporcionar los siguientes campos cuando configure una integración de Datadog:

Propiedad	Descripción
`type`	`DATADOG`
`apiKey`	Su clave API. Después de crear una integración de terceros que requiere una API o una clave de integración, la clave aparece parcialmente redactada cuando: Ver o editar la alerta a través de la interfaz de usuario. Consulta la configuración de integración de terceros a través de la API.

HipChat

Debe proporcionar los siguientes campos cuando configure una integración de HipChat:

Propiedad	Descripción
`type`	`HIP_CHAT`
`notificationToken`	Token de notificación para su cuenta de usuario de HipChat. Después de crear una integración de terceros que requiere una API o una clave de integración, la clave aparece parcialmente redactada cuando: Ver o editar la alerta a través de la interfaz de usuario. Consulta la configuración de integración de terceros a través de la API.
`roomName`	El nombre de tu sala de HipChat.

Opsgenie

Debe proporcionar los siguientes campos cuando configure una integración de Opsgenie:

Propiedad	Descripción
`type`	`OPS_GENIE`
`apiKey`	Su clave API. Después de crear una integración de terceros que requiere una API o una clave de integración, la clave aparece parcialmente redactada cuando: Ver o editar la alerta a través de la interfaz de usuario. Consulta la configuración de integración de terceros a través de la API.
`region`	Indica qué URL de API se utiliza: `US` o `EU`. Opsgenie usará `US` de forma predeterminada.

Para establecer region EUen, debe establecer una configuración de opsgenie.api.url cliente de.

VictorOps

Debe proporcionar los siguientes campos cuando configure una integración de VictorOps:

Propiedad	Descripción
`type`	`VICTOR_OPS`
`apiKey`	Su clave API. Después de crear una integración de terceros que requiere una API o una clave de integración, la clave aparece parcialmente redactada cuando: Ver o editar la alerta a través de la interfaz de usuario. Consulta la configuración de integración de terceros a través de la API.

También puede incluir los siguientes campos:

Propiedad	Descripción
`routingKey`	Un campo opcional para su clave de enrutamiento.

Configuración del webhook

Debe proporcionar los siguientes campos al configurar los ajustes del webhook:

Propiedad	Descripción
`type`	`WEBHOOK`
`url`	La URL de su webhook.

También puede incluir los siguientes campos:

Propiedad	Descripción
`secret`	Un campo opcional para su secreto de webhook. Después de crear una notificación de webhook, la URL se redacta parcialmente cuando usted ve o edita la alerta, y el secreto se redacta por completo.

Microsoft Teams

Debe proporcionar los siguientes campos cuando configure una integración de Microsoft Teams:

Propiedad	Descripción
`type`	`MICROSOFT_TEAMS`
`microsoftTeamsWebhookUrl`	La URL del webhook entrante de Microsoft Teams. Cuando se ve o edita la alerta de una notificación de webhook, la URL aparece parcialmente oculta y el secreto aparece completamente oculto.

Prometheus

Debe proporcionar los siguientes campos cuando configure una integración de Prometheus:

Propiedad	Descripción
`type`	`PROMETHEUS`
`username`	Su nombre de usuario de Prometheus.
`password`	Su contraseña de Prometeo.
`listenAddress`	La dirección IP y el puerto al que se comunicará su instancia de Prometheus.
`serviceDiscovery`	Indica qué método de descubrimiento de servicio se utiliza, `file` o `http`.
`scheme`	Su esquema de protocolo Prometheus configurado para solicitudes, `http` o `https`. Si configura `https`, debe especificar `tlsPemPath`.
`enabled`	Si su clúster tiene Prometheus habilitado.

También puede incluir los siguientes campos:

Propiedad	Descripción
`tlsPemPassword`	Un campo opcional para la contraseña de su archivo PEM.
`tlsPemPath`	Un campo opcional para la ruta absoluta a su archivo PEM.

Elementos de respuesta

La respuesta incluye una matriz results que enumera todas las configuraciones de integración de terceros para el proyecto como objetos y un totalCount de los servicios integrados con el proyecto.

Cada objeto de configuración de integración de terceros incluye una propiedad type que corresponde a su propio tipo de integración ("type": "PAGER_DUTY" para el servicio PagerDuty). Además, cada objeto de configuración de servicio de terceros proporciona detalles específicos de dicho servicio. A continuación, se enumeran las propiedades devueltas para cada objeto de configuración de servicio de terceros:

Servicio

Resultado

PagerDuty

Un objeto de configuración de integración de PagerDuty devuelto contiene los siguientes campos:

Propiedad	Descripción
`type`	`PAGER_DUTY`
`serviceKey`	Su clave de servicio. Después de crear una integración de terceros que requiere una API o una clave de integración, la clave aparece parcialmente redactada cuando: Ver o editar la alerta a través de la interfaz de usuario. Consulta la configuración de integración de terceros a través de la API.

Slack

Un objeto de configuración de integración de Slack devuelto contiene los siguientes campos:

Propiedad	Descripción
`type`	`SLACK`
`apiToken`	Su token API. Después de crear una integración de terceros que requiere una API o una clave de integración, la clave aparece parcialmente redactada cuando: Ver o editar la alerta a través de la interfaz de usuario. Consulta la configuración de integración de terceros a través de la API.
`teamName`	Nombre de tu equipo. Es posible que este campo no esté disponible con una integración de Slack heredada.
`channelName`	El nombre del canal de Slack configurado. Una cadena vacía si no se ha definido ningún valor.

Datadog

Un objeto de configuración de integración de Datadog devuelto contiene los siguientes campos:

Propiedad	Descripción
`type`	`DATADOG`
`apiKey`	Su clave API. Después de crear una integración de terceros que requiere una API o una clave de integración, la clave aparece parcialmente redactada cuando: Ver o editar la alerta a través de la interfaz de usuario. Consulta la configuración de integración de terceros a través de la API.

HipChat

Un objeto de configuración de integración de HipChat devuelto contiene los siguientes campos:

Propiedad	Descripción
`type`	`HIP_CHAT`
`notificationToken`	Token de notificación para su cuenta de usuario de HipChat. Después de crear una integración de terceros que requiere una API o una clave de integración, la clave aparece parcialmente redactada cuando: Ver o editar la alerta a través de la interfaz de usuario. Consulta la configuración de integración de terceros a través de la API.
`roomName`	El nombre de tu sala de HipChat.

Opsgenie

Un objeto de configuración de integración de Opsgenie devuelto contiene los siguientes campos:

Propiedad	Descripción
`type`	`OPS_GENIE`
`apiKey`	Su clave API. Después de crear una integración de terceros que requiere una API o una clave de integración, la clave aparece parcialmente redactada cuando: Ver o editar la alerta a través de la interfaz de usuario. Consulta la configuración de integración de terceros a través de la API.
`region`	Indica qué URL de API usar,`US` `EU`o. El valor predeterminado de Opsgenie `US` es.

Para establecer region EUen, debe establecer una configuración de opsgenie.api.url cliente de.

VictorOps

Un objeto de configuración de integración de VictorOps devuelto contiene los siguientes campos:

Propiedad	Descripción
`type`	`VICTOR_OPS`
`apiKey`	Su clave API. Después de crear una integración de terceros que requiere una API o una clave de integración, la clave aparece parcialmente redactada cuando: Ver o editar la alerta a través de la interfaz de usuario. Consulta la configuración de integración de terceros a través de la API.

El objeto de configuración también puede contener los siguientes campos, según su configuración:

Propiedad	Descripción
`routingKey`	Un campo opcional que se devuelve si tiene una clave de enrutamiento configurada.

Configuración del webhook

Un objeto de configuración de webhook devuelto contiene los siguientes campos:

Propiedad	Descripción
`type`	`WEBHOOK`
`url`	La URL de su webhook. Después de crear una notificación de webhook, la URL se redacta parcialmente cuando usted ve o edita la alerta, y el secreto se redacta por completo.

El objeto de configuración también puede contener los siguientes campos, según su configuración:

Propiedad	Descripción
`secret`	Un campo opcional que se devuelve si su webhook está configurado con un secreto.

Microsoft Teams

Un objeto de configuración de Microsoft Teams devuelto contendrá los siguientes campos:

Propiedad	Descripción
`type`	`MICROSOFT_TEAMS`
`microsoftTeamsWebhookUrl`	La URL del webhook entrante de Microsoft Teams. Cuando se ve o edita la alerta de una notificación de webhook, la URL aparece parcialmente oculta y el secreto aparece completamente oculto.

Prometheus

Un objeto de configuración de Prometheus devuelto contendrá los siguientes campos:

Propiedad	Descripción
`type`	`PROMETHEUS`
`username`	Su nombre de usuario de Prometheus.
`listenAddress`	La dirección IP y el puerto al que se comunicará su instancia de Prometheus.
`serviceDiscovery`	Indica qué método de descubrimiento de servicio se utiliza, `file` o `http`.
`scheme`	Su esquema de protocolo Prometheus configurado para solicitudes, `http` o `https`. Si configura `https`, debe especificar `tlsPemPath`.
`enabled`	Si su clúster tiene Prometheus habilitado.

El objeto de configuración también puede contener los siguientes campos, según su configuración:

Propiedad	Descripción
`tlsPemPassword`	Un campo opcional que se devuelve si tiene una contraseña para su archivo PEM.
`tlsPemPath`	Un campo opcional que se devuelve si tiene una ruta absoluta a su archivo PEM.

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 POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/integrations/SLACK" \
6      --data '
7      {
8        "type": "SLACK",
9        "apiToken": "1234567890",
10        "teamName": "My Team"

Ejemplo de respuesta

1 {
2   "links": [
3     {
4       "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/integrations/SLACK?pageNum=1&itemsPerPage=100",
5       "rel": "self"
6     }
7   ],
8   "results": [
9     {
10       "serviceKey": "******7890",
11       "type": "PAGER_DUTY"
12     },
13     {
14       "apiToken": "******7890",
15       "channelName": "My Channel",
16       "teamName": "My Team",
17       "type": "SLACK"
18     }
19   ],
20   "totalCount": 2
21 }

Volver

Obtener una configuración

Update

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--include \
5	--request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/integrations/SLACK" \
6	--data '
7	{
8	"type": "SLACK",
9	"apiToken": "1234567890",
10	"teamName": "My Team"

1	{
2	"links": [
3	{
4	"href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/integrations/SLACK?pageNum=1&itemsPerPage=100",
5	"rel": "self"
6	}
7	],
8	"results": [
9	{
10	"serviceKey": "******7890",
11	"type": "PAGER_DUTY"
12	},
13	{
14	"apiToken": "******7890",
15	"channelName": "My Channel",
16	"teamName": "My Team",
17	"type": "SLACK"
18	}
19	],
20	"totalCount": 2
21	}