Nota
Grupos y proyectos son términos sinónimos. Su {PROJECT-ID} es el mismo que su ID del grupo. Para los grupos existentes, su ID del grupo sigue siendo el mismo. Esta página utiliza el término más familiar grupo cuando se refiere a descripciones. El punto final permanece como se indica en el documento.
URL base: https://cloud.mongodb.com/api/public/v1.0
Utilice este punto final para reemplazar una configuración de integración de servicio de terceros existente para un proyecto. Este punto final utiliza la semántica de inserción: si ya existe una configuración para el tipo de integración especificado, Cloud Manager la reemplaza con los valores que proporcione. Si no existe ninguna configuración para ese tipo, Cloud Manager añade una nueva. Para añadir una configuración sin reemplazar una existente, utilice el punto final Crear una configuración en su lugar.
Sintaxis
PUT /groups/{GROUP-ID}/integrations/{INTEGRATION-TYPE}Parámetros de ruta de solicitud
Parameter | Necesidad | Descripción |
|---|---|---|
| Requerido | Identificador del proyecto. |
| Requerido | Identificador de servicio de terceros. Los valores aceptados son:
|
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. |
|
elementosPorPágina | Número | Opcional | Número de elementos a devolver por página, hasta un máximo de 500. |
|
bonito | booleano | Opcional | Indicador que señala si el cuerpo de la respuesta debe estar en formato prettyprint. |
|
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 ni al código de estado. Para corregir esto, establezca Para los endpoints que devuelven una lista de resultados, el objeto |
|
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 |
|
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. La solicitud reemplaza toda la configuración para el type especificado. Incluya siempre una propiedad type igual al servicio de terceros INTEGRATION_TYPE.
PagerDuty
Se deben proporcionar los siguientes campos al configurar una integración con PagerDuty:
Propiedad | Descripción |
|---|---|
|
|
| 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:
|
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 |
|---|---|
|
|
| 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:
|
| El nombre de tu equipo. |
También puede incluir los siguientes campos:
Propiedad | Descripción |
|---|---|
| El nombre del canal a reconfigurar. |
Opsgenie
Debes proporcionar los siguientes campos cuando configures una integración con Opsgenie:
Propiedad | Descripción |
|---|---|
|
|
| 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:
|
| Indica qué API URL utilizar, ya sea |
VictorOps
Debe proporcionar los siguientes campos al configurar una integración de VictorOps:
Propiedad | Descripción |
|---|---|
|
|
| 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:
|
También puede incluir los siguientes campos:
Propiedad | Descripción |
|---|---|
| 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 |
|---|---|
|
|
| Su URL de webhook. |
También puede incluir los siguientes campos:
Propiedad | Descripción |
|---|---|
| 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 |
|---|---|
|
|
| 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 |
|---|---|
|
|
| Su nombre de usuario de Prometheus. |
| Tu contraseña de Prometheus. |
| La dirección IP y puerto a los que llegará tu instancia de Prometheus. |
| Indica qué método de descubrimiento de servicios se utiliza, ya sea |
| Tu esquema de protocolo Prometheus configurado para solicitudes, ya sea |
| Si tu clúster tiene Prometheus habilitado. |
También puede incluir los siguientes campos:
Propiedad | Descripción |
|---|---|
| Un campo opcional para la contraseña de tu archivo PEM. |
| 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:
PagerDuty
Un objeto de configuración de integración de PagerDuty devuelto contiene los siguientes campos:
Propiedad | Descripción |
|---|---|
|
|
| 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:
|
Slack
Un objeto de configuración de integración de Slack devuelto contiene los siguientes campos:
Propiedad | Descripción |
|---|---|
|
|
| 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:
|
| El nombre de tu equipo. Este campo puede no estar presente en una integración heredada de Slack. |
| 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 |
|---|---|
|
|
| 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:
|
| Indica qué API URL utilizar, ya sea |
VictorOps
Un objeto de configuración de integración de VictorOps devuelto contiene los siguientes campos:
Propiedad | Descripción |
|---|---|
|
|
| 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:
|
El objeto de configuración también puede contener los siguientes campos, dependiendo de tu configuración:
Propiedad | Descripción |
|---|---|
| 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 |
|---|---|
|
|
| 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 |
|---|---|
| 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 |
|---|---|
|
|
| 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 |
|---|---|
|
|
| Su nombre de usuario de Prometheus. |
| La dirección IP y puerto a los que llegará tu instancia de Prometheus. |
| Indica qué método de descubrimiento de servicios se utiliza, ya sea |
| Tu esquema de protocolo Prometheus configurado para solicitudes, ya sea |
| 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 |
|---|---|
| Un campo opcional devuelto si tienes una contraseña para tu archivo PEM. |
| Un campo opcional que se devuelve si tienes una ruta absoluta a tu archivo PEM. |
Solicitud de ejemplo
El siguiente ejemplo reemplaza la configuración de integración de Slack existente para el proyecto.
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request PUT "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/integrations/SLACK" \ --data ' { "type": "SLACK", "apiToken": "1234567890", "teamName": "My Team" }'Respuesta de ejemplo
{ "links": [ { "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/integrations/SLACK?pageNum=1&itemsPerPage=100", "rel": "self" } ], "results": [ { "serviceKey": "******7890", "type": "PAGER_DUTY" }, { "apiToken": "******7890", "channelName": "My Channel", "teamName": "My Team", "type": "SLACK" } ], "totalCount": 2}