Para agentes de IA: hay un índice de documentación disponible en https://www.mongodb.com/es/docs/llms.txt — versiones en markdown de todas las páginas están disponibles agregando .md a cualquier ruta URL.

Obtener la configuración de una integración de servicio de terceros

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

GET /groups/{PROJECT-ID}/integrations/{INTEGRATION-TYPE}
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

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 ni al código de estado. Para corregir esto, establezca envelope : true en la query.

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

Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.

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:

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.

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.

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.

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.

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 utilizar, ya sea US o EU. Opsgenie utiliza por defecto US.

Para establecer region en EU, debe establecer una configuración personalizada de opsgenie.api.url.

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.

routingKey

Condicional. Solo se devuelve si tiene una clave de enrutamiento configurada.

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.

secret

Condicional. Solo se devuelve si su webhook está configurado con un secreto.

oauth2Config

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.

oauth2Config.tokenUrl

Punto de conexión de token que llama MongoDB Ops Manager para obtener un token de acceso de portador.

oauth2Config.clientId

Identificador de cliente que utiliza MongoDB Ops Manager al autenticarse en el punto final del token OAuth 2.0.

oauth2Config.clientSecret

Secreto de cliente que MongoDB Ops Manager utiliza con el ID de cliente al autenticarse en el punto final del token OAuth 2.0.

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.

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.

tlsPemPassword

Condicional. Solo se devuelve si tiene una contraseña para su archivo PEM.

tlsPemPath

Condicional. Solo se devuelve si tiene una ruta absoluta a su archivo PEM.

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"
{ "serviceKey": "******7890", "type": "PAGER_DUTY"}