/ /

Mediciones y alertas

Configuración de integración

Docs Home

Gestión

Gerente de Operaciones

API

Recursos

Mediciones y alertas

Configuración de integración

Actualiza una configuración para una integración de servicio de terceros

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 grupo/proyecto permanece igual. Esta página utiliza el término más familiar «grupo» al referirse a las descripciones. El punto final se mantiene como se indica en el documento.

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

Sintaxis

PUT /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 Solicitud Query

Nombre	Tipo	Necesidad	Descripción	predeterminado
Num. de pág.	Número	Opcional	Entero basado en uno que devuelve una subsección de resultados.	`1`
elementosPorPágina	Número	Opcional	Número de elementos a devolver por página, hasta un máximo de 500.	`100`
bonito	booleano	Opcional	Bandera que indica si el cuerpo de la respuesta debe estar en una pretty-print formato.	`false`
envelope	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 endpoints que devuelven una lista de resultados, el objeto `content` es un sobre. Ops Manager agrega el campo `status` al cuerpo de la respuesta.	`false`

Parámetros del cuerpo de la solicitud

El cuerpo de la solicitud debe ser una única vista de integración (como un objeto de configuración JSON) para un único servicio de terceros. Si ya existe una configuración de la misma type, la solicitud actualizará los campos cambiados. Si no existe una configuración de la misma type, se añadirá. Siempre incluya una propiedad type igual al servicio de terceros INTEGRATION_TYPE.

Servicio

Opciones de configuración

PagerDuty

Se deben proporcionar los siguientes campos al configurar una integración con PagerDuty:

Propiedad

Descripción

type

PAGER_DUTY

serviceKey

Su clave de integración.

IMPORTANTE: Cambiar la clave de integración no afecta a las alertas que usen esta integración. Esas alertas aún usan la clave de integración anterior. Remové y volvé a añadir cada notificación de PagerDuty para usar la nueva clave.

Todas las nuevas claves de PagerDuty utilizan su Events API v2. Si tienes una llave API de Eventos v1, puedes seguir utilizándola con Ops Manager.

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:

Visualiza o edita 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 del MongoDB Atlas página de integraciones de servicios de terceros. Los tokens heredados pronto dejarán de ser compatibles.

Debes proporcionar los siguientes campos cuando reconfigures una integración existente de Slack:

Propiedad	Descripción
`type`	`SLACK`
`apiToken`	Tu token de 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: Visualiza o edita 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

Debes proporcionar los siguientes campos cuando configures una integración de Datadog:

Propiedad	Descripción
`type`	`DATADOG`
`apiKey`	Tu 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: Visualiza o edita 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 tu 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: Visualiza o edita 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

Debes proporcionar los siguientes campos cuando configures una integración con Opsgenie:

Propiedad	Descripción
`type`	`OPS_GENIE`
`apiKey`	Tu 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: Visualiza o edita 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, ya sea `US` o `EU`. Opsgenie usará `US` por defecto.

Para establecer region en EU, debes establecer una configuración de cliente de opsgenie.api.url.

VictorOps

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

Propiedad	Descripción
`type`	`VICTOR_OPS`
`apiKey`	Tu 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: Visualiza o edita 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 tu clave de enrutamiento.

Configuración del webook

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

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

También puede incluir los siguientes campos:

Propiedad	Descripción
`secret`	Un campo opcional para el secreto de tu webhook. Después de crear una notificación de webhook, la URL está parcialmente redactada cuando ves o editas la alerta, y el secreto está completamente redactado.

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 puerto a los que llegará tu instancia de Prometheus.
`serviceDiscovery`	Indica qué método de descubrimiento de servicios se utiliza, ya sea `file` o `http`.
`scheme`	Tu esquema de protocolo Prometheus configurado para solicitudes, ya sea `http` o `https`. Si configuras `https`, debes especificar `tlsPemPath`.
`enabled`	Si tu 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 tu 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 igual 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 ese servicio. Las siguientes listas muestran las propiedades devueltas para cada objeto de configuración de servicios 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: Visualiza o edita 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`	Tu token de 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: Visualiza o edita 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. Este campo puede no estar presente en una integración heredada de Slack.
`channelName`	El nombre del canal de Slack configurado. Una string vacía si el valor no está establecido.

Datadog

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

Propiedad	Descripción
`type`	`DATADOG`
`apiKey`	Tu 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: Visualiza o edita 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 tu 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: Visualiza o edita 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`	Tu 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: Visualiza o edita 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é API URL usar, ya sea `US` o `EU`. Opsgenie utiliza `US` por defecto.

Para establecer region en EU, debes establecer una configuración de cliente de opsgenie.api.url.

VictorOps

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

Propiedad	Descripción
`type`	`VICTOR_OPS`
`apiKey`	Tu 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: Visualiza o edita 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 tienes configurada una clave de enrutamiento.

Configuración del webook

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

Propiedad	Descripción
`type`	`WEBHOOK`
`url`	Su URL de webhook. Después de crear una notificación de webhook, la URL está parcialmente redactada cuando ves o editas la alerta, y el secreto está completamente redactado.

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 puerto a los que llegará tu instancia de Prometheus.
`serviceDiscovery`	Indica qué método de descubrimiento de servicios se utiliza, ya sea `file` o `http`.
`scheme`	Tu esquema de protocolo Prometheus configurado para solicitudes, ya sea `http` o `https`. Si configuras `https`, debes especificar `tlsPemPath`.
`enabled`	Si tu 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 devuelto si tienes una contraseña para tu archivo PEM.
`tlsPemPath`	Un campo opcional que se devuelve si tienes una ruta absoluta a tu archivo PEM.

Solicitud de ejemplo

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

Respuesta de ejemplo

1 {
2   "links": [
3     {
4       "href": "https://cloud.mongodb.com/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

Crear

Borrar

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

1	{
2	"links": [
3	{
4	"href": "https://cloud.mongodb.com/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	}