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
Sintaxis
GET /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
Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.
Elementos de respuesta
La respuesta devuelve el objeto de configuración de integración de terceros especificado si ese servicio ha sido configurado. Si no se ha configurado, la respuesta devolverá un error INTEGRATION_NOT_CONFIGURED.
Cada objeto de configuración de integración de terceros incluye una propiedad type igual a su propio tipo de integración (como "type": "PAGER_DUTY"). 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
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/integrations/PAGER_DUTY"Respuesta de ejemplo
{ "serviceKey": "******7890", "type": "PAGER_DUTY"}