/ /

Mediciones y alertas

Integraciones de terceros

Integraciones de terceros

Cree una configuración para la integración de un servicio de terceros

Nota

Los términos «grupos» y «proyectos» son sinónimos. Tu {PROJECT-ID} ID de grupo es el mismo que el tuyo. Para los grupos existentes, tu ID de grupo/proyecto permanece igual. En esta página se utiliza el término «grupo», más común, para las descripciones. El punto final se mantiene como se indica en el documento.

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

Utilice este punto final para agregar una nueva configuración de integración de servicios de terceros a un proyecto. Cada proyecto admite una configuración por {INTEGRATION-TYPE}. Si ya existe una configuración para el tipo de integración especificado, la solicitud falla. Para reemplazar una configuración existente, utilice el punto final Actualizar una configuración en su lugar.

Sintaxis

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

Parámetros de 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: `PAGER_DUTY` `SLACK` `NEW_RELIC` `OPS_GENIE` `VICTOR_OPS` `WEBHOOK` `PROMETHEUS`

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	Indicador que señala 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 o al código de estado. Para remediarlo, establezca `envelope : true` en la query. Para los endpoints que devuelven una lista de resultados, el objeto `content` es un sobre. Cloud Manager añade el campo `status` al cuerpo de la respuesta.	`false`
backupJobsEnabledOnly	booleano	Opcional	Indicador que indica si se deben excluir los demonios que no están habilitados para hacer copias de seguridad de bases de datos de la respuesta. Establece esto en `false` para incluir las configuraciones del demonio con la bandera `backupJobsEnabled` establecida en `false`.	`true`

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 que se agregará al proyecto. Siempre incluya una propiedad type igual a el INTEGRATION_TYPE del servicio externo.

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

Tu llave de servicio.

Todas las nuevas claves de PagerDuty utilizan su Events API v2. Si tienes una clave API de Eventos v1, puedes seguir usando esa clave con Cloud 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 de la página de integraciones de servicios de terceros de MongoDB Atlas. Pronto los tokens heredados 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.

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é API URL usar, ya sea `US` o `EU`. Opsgenie utiliza `US` por defecto.

VictorOps

Debe proporcionar los siguientes campos al configurar 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

Debes proporcionar los siguientes campos cuando configures 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`	Tu URL de 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`	Tu contraseña 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.

También puede incluir los siguientes campos:

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

Elementos de respuesta

La respuesta incluye un results arreglo 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`	Tu llave 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.

Opsgenie

Un objeto de configuración devuelto por la integración de Opsgenie 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.

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, dependiendo de tu 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, dependiendo de tu 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`	Tu URL de 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, dependiendo de tu 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

El siguiente ejemplo agrega una nueva configuración de integración de Slack al proyecto.

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://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

Obtener Una Configuración

Actualizar una configuración

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://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	}