Observação
Grupos e projetos são termos sinônimos. Seu {PROJECT-ID} é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. Esta página usa o termo grupo, que é mais familiar, ao se referir a descrições. O ponto de extremidade permanece conforme indicado no documento.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Sintaxe
PUT /groups/{PROJECT-ID}/integrations/{INTEGRATION-TYPE}Parâmetros do caminho da solicitação
Parâmetro | necessidade | Descrição |
|---|---|---|
| Obrigatório | Identificador do projeto. |
| Obrigatório | Identificador de serviço de terceiros. Os valores aceitos são:
|
Solicitar parâmetros de query
Nome | Tipo | necessidade | Descrição | Default |
|---|---|---|---|---|
pageNum | número | Opcional | Um inteiro baseado que retorna uma subseção de resultados. |
|
itemsPerPage | número | Opcional | Número de itens a serem devolvidos por página, até um máximo de 500. |
|
pretty | booleano | Opcional | Sinalizador que indica se o corpo da resposta deve estar em um formato de impressão bonita. |
|
envelope | booleano | Opcional | Sinalizador que indica se deseja ou não envolver a resposta em um envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, configure Para endpoints que retornam uma lista de resultados, o objeto |
|
Parâmetros do corpo da solicitação
O corpo da solicitação deve ser uma única visualização de integração (como um objeto de configuração JSON) para um único serviço de terceiros. Se uma configuração do mesmo type já existir, a solicitação atualizará os campos alterados. Se uma configuração do mesmo type não existir, ela será adicionada. Sempre inclua uma propriedade type igual ao serviço de terceiros INTEGRATION_TYPE.
PagerDuty
Você deve fornecer os seguintes campos ao configurar uma integração PagerDuty:
Propriedade | Descrição |
|---|---|
|
|
| Sua chave de integração. IMPORTANTE: alterar a chave de integração não altera nenhum alerta que use essa integração. Esses alertas ainda usam a chave de integração anterior. Remova e adicione novamente cada notificação do PagerDuty para usar a nova chave. Todas as novas chaves do PagerDuty usam sua API de eventos v2. Se você tiver uma chave de API de eventos v1, poderá continuar a usar essa chave com o Ops Manager. Depois de criar uma integração de terceiros que requer uma API ou chave de integração, a chave aparece parcialmente oculta quando você:
|
Slack
Importante
As integrações do Slack agora usam o método de verificação OAuth2 e devem ser configuradas inicialmente, ou atualizadas de uma integração legado, por meio da página de integrações de serviços de terceiros do MongoDB Atlas. Tokens legados em breve não terão mais suporte.
Você deve fornecer os seguintes campos ao reconfigurar uma integração existente do Slack:
Propriedade | Descrição |
|---|---|
|
|
| Seu token de API. Depois de criar uma integração de terceiros que requer uma API ou chave de integração, a chave aparece parcialmente oculta quando você:
|
| Nome da sua equipe. |
| Opcional. O nome do canal a ser reconfigurado. |
Datadog
Você deve fornecer os seguintes campos ao configurar uma integração do Datadog:
Propriedade | Descrição |
|---|---|
|
|
| Sua chave de API. Depois de criar uma integração de terceiros que requer uma API ou chave de integração, a chave aparece parcialmente oculta quando você:
|
HipChat
Você deve fornecer os seguintes campos ao configurar uma integração com o HipChat:
Propriedade | Descrição |
|---|---|
|
|
| Token de notificação para sua conta de usuário do HipChat. Depois de criar uma integração de terceiros que requer uma API ou chave de integração, a chave aparece parcialmente oculta quando você:
|
| O nome da sua divisão no HipChat. |
Opsgenie
Você deve fornecer os seguintes campos ao configurar uma integração Opsgenie:
Propriedade | Descrição |
|---|---|
|
|
| Sua chave de API. Depois de criar uma integração de terceiros que requer uma API ou chave de integração, a chave aparece parcialmente oculta quando você:
|
| Indica qual URL da API é usada, |
Para definir region como EU, você deve definir uma configuração personalizada de opsgenie.api.url.
VictorOps
Você deve fornecer os seguintes campos ao configurar uma integração VictorOps:
Propriedade | Descrição |
|---|---|
|
|
| Sua chave de API. Depois de criar uma integração de terceiros que requer uma API ou chave de integração, a chave aparece parcialmente oculta quando você:
|
| Opcional. Sua Chave de Roteamento. |
Configurações do webhook
Você deve fornecer os seguintes campos ao definir as configurações do webhook:
Propriedade | Descrição |
|---|---|
|
|
| Sua URL do webhook. |
| Opcional. Seu segredo de webhook. Depois de criar uma notificação de webhook, o URL é parcialmente redigido quando você visualiza ou edita o alerta, e o segredo é totalmente redigido. |
| Opcional. Credenciais de cliente OAuth 2.0 que o MongoDB Ops Manager usa para obter um token de acesso de portador para notificações de webhook. Se você especificar este campo, defina |
| Ponto de extremidade de token que o MongoDB Ops Manager chama para obter um token de acesso de portador. |
| Identificador de cliente que o MongoDB Ops Manager usa ao autenticar no ponto de extremidade do token OAuth 2.0. |
| Segredo do cliente que o MongoDB Ops Manager usa com o ID do cliente ao autenticar no ponto de extremidade do token OAuth 2.0. |
Equipes da Microsoft
Você deve fornecer os seguintes campo ao configurar uma integração do Microsoft equipe:
Propriedade | Descrição |
|---|---|
|
|
| A URL do webhook de entrada do Microsoft equipe. Quando você exibe ou edita o alerta de uma notificação de webhook, o URL aparece parcialmente redigido, e o segredo aparece completamente redigido. |
Prometeu(a)
Você deve fornecer os seguintes campos ao configurar uma integração Prometheus:
Propriedade | Descrição |
|---|---|
|
|
| Seu nome de usuário Prometheus. |
| Sua senha Prometheus. |
| O endereço IP e a porta que sua instância Prometheus alcançará. |
| Indica qual método de descoberta de serviço é usado, |
| Seu esquema de protocolo Prometheus configurado para solicitações, |
| Se o seu cluster tem o Prometheus habilitado. |
| Opcional. A senha do seu arquivo PEM. |
| Opcional. O caminho absoluto para seu arquivo PEM. |
Elementos de resposta
A resposta inclui uma matriz results que lista todas as configurações de integração de terceiros para o projeto como objetos e um totalCount dos serviços integrados ao projeto.
Cada objeto de configuração de integração de terceiros inclui uma propriedade type igual ao seu próprio tipo de integração ("type": "PAGER_DUTY" para o serviço PagerDuty). Além disso, cada objeto de configuração de serviço de terceiros fornece detalhes específicos para esse serviço. A seguir, listamos as propriedades retornadas para cada objeto de configuração de serviço de terceiros:
PagerDuty
Um objeto de configuração de integração PagerDuty retornado contém os seguintes campos:
Propriedade | Descrição |
|---|---|
|
|
| Sua chave de serviço. Depois de criar uma integração de terceiros que requer uma API ou chave de integração, a chave aparece parcialmente oculta quando você:
|
Slack
Um objeto de configuração de integração do Slack retornado contém os seguintes campos:
Propriedade | Descrição |
|---|---|
|
|
| Seu token de API. Depois de criar uma integração de terceiros que requer uma API ou chave de integração, a chave aparece parcialmente oculta quando você:
|
| Nome da sua equipe. Este campo pode não estar presente com uma integração legada do Slack. |
| O nome do canal Slack configurado. Uma string vazia se o valor não estiver definido. |
Datadog
Um objeto de configuração de integração do Datadog retornado contém os seguintes campos:
Propriedade | Descrição |
|---|---|
|
|
| Sua chave de API. Depois de criar uma integração de terceiros que requer uma API ou chave de integração, a chave aparece parcialmente oculta quando você:
|
HipChat
Um objeto de configuração de integração do HipChat retornado contém os seguintes campos:
Propriedade | Descrição |
|---|---|
|
|
| Token de notificação para sua conta de usuário do HipChat. Depois de criar uma integração de terceiros que requer uma API ou chave de integração, a chave aparece parcialmente oculta quando você:
|
| O nome da sua divisão no HipChat. |
Opsgenie
Um objeto de configuração de integração Opsgenie retornado contém os seguintes campos:
Propriedade | Descrição |
|---|---|
|
|
| Sua chave de API. Depois de criar uma integração de terceiros que requer uma API ou chave de integração, a chave aparece parcialmente oculta quando você:
|
| Indica qual API URL usar, seja |
Para definir region como EU, você deve definir uma configuração personalizada de opsgenie.api.url.
VictorOps
Um objeto de configuração de integração do VictorOps retornado contém os seguintes campos:
Propriedade | Descrição |
|---|---|
|
|
| Sua chave de API. Depois de criar uma integração de terceiros que requer uma API ou chave de integração, a chave aparece parcialmente oculta quando você:
|
| Condicional. Só será retornado se você tiver uma chave de roteamento configurada. |
Configurações do webhook
Um objeto de configuração do webhook retornado contém os seguintes campos:
Propriedade | Descrição |
|---|---|
|
|
| Sua URL do webhook. Depois de criar uma notificação de webhook, o URL é parcialmente redigido quando você visualiza ou edita o alerta, e o segredo é totalmente redigido. |
| Condicional. Só será retornado se o seu webhook estiver configurado com um segredo. |
| Credenciais de cliente OAuth 2.0 que o MongoDB Ops Manager usa para obter um token de acesso de portador para notificações de webhook. Retornado apenas se o seu webhook estiver configurado com credenciais de cliente OAuth 2.0. |
| Ponto de extremidade de token que o MongoDB Ops Manager chama para obter um token de acesso de portador. |
| Identificador de cliente que o MongoDB Ops Manager usa ao autenticar no ponto de extremidade do token OAuth 2.0. |
| Segredo do cliente que o MongoDB Ops Manager usa com o ID do cliente ao autenticar no ponto de extremidade do token OAuth 2.0. |
Equipes da Microsoft
Um objeto de configuração do Microsoft equipe retornado conterá os seguintes campo:
Propriedade | Descrição |
|---|---|
|
|
| A URL do webhook de entrada do Microsoft equipe. Quando você exibe ou edita o alerta de uma notificação de webhook, o URL aparece parcialmente redigido, e o segredo aparece completamente redigido. |
Prometeu(a)
Um objeto de configuração Prometheus retornado conterá os seguintes campos:
Propriedade | Descrição |
|---|---|
|
|
| Seu nome de usuário Prometheus. |
| O endereço IP e a porta que sua instância Prometheus alcançará. |
| Indica qual método de descoberta de serviço é usado, |
| Seu esquema de protocolo Prometheus configurado para solicitações, |
| Se o seu cluster tem o Prometheus habilitado. |
| Condicional. Só é retornado se você tiver uma senha para o seu arquivo PEM. |
| Condicional. Só será retornado se você tiver um caminho absoluto para o seu arquivo PEM. |
Exemplo de solicitação
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" }'Exemplo de resposta
{ "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 }