Nota
Grupos y proyectos son términos sinónimos. Su {PROJECT-ID} es el mismo que su ID del grupo. Para los grupos existentes, el ID del grupo se mantiene igual. Esta página utiliza el término más familiar grupo cuando se refiere a descripciones. El endpoint permanece tal como se indica en el documento.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Sintaxis
GET /api/public/v1.0/groups/{PROJECT-ID}/integrationsParámetros de ruta de solicitud
Parameter | Necesidad | Descripción |
|---|---|---|
| Requerido | Identificador del proyecto. |
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 |
|
Parámetros del cuerpo de la solicitud
Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.
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 (por ejemplo, "type": "PAGER_DUTY" para el servicio de PagerDuty). Adicionalmente, cada objeto de configuración de servicios de terceros proporciona detalles especÃficos para ese servicio. A continuación se enumeran 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. |
Datadog
Un objeto de configuración de integración de Datadog 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:
|
HipChat
Un objeto de configuración de integración de HipChat devuelto contiene los siguientes campos:
Propiedad | Descripción |
|---|---|
|
|
| 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:
|
| El nombre de tu sala de HipChat. |
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 |
Para establecer region en EU, debe establecer una configuración personalizada de opsgenie.api.url.
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:
|
| Condicional. Solo se devuelve si tiene una clave de enrutamiento configurada. |
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. |
| Condicional. Solo se devuelve si su webhook está configurado con un secreto. |
| Credenciales de cliente OAuth 2.0 que MongoDB Ops Manager utiliza para obtener un token de acceso de portador para las notificaciones de webhook. Solo se devuelve si su webhook está configurado con credenciales de cliente OAuth 2.0. |
| Punto de conexión de token que llama MongoDB Ops Manager para obtener un token de acceso de portador. |
| Identificador de cliente que utiliza MongoDB Ops Manager al autenticarse en el punto final del token OAuth 2.0. |
| Secreto de cliente que MongoDB Ops Manager utiliza con el ID de cliente al autenticarse en el punto final del token OAuth 2.0. |
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. |
| Condicional. Solo se devuelve si tiene una contraseña para su archivo PEM. |
| Condicional. Solo se devuelve si tiene una ruta absoluta a su 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"Respuesta de ejemplo
{ "links": [ { "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/integrations?pageNum=1&itemsPerPage=100", "rel": "self" } ], "results": [ { "serviceKey": "******7890", "type": "PAGER_DUTY" }, { "apiToken": "******7890", "channelName": "My Channel", "teamName": "My Team", "type": "SLACK" }, ], "totalCount": 2 }