Menu Docs
Página inicial do Docs
/
MongoDB Ops Manager
/
API
/
Recursos
/
Medições e alertas
/
Configurações de integração

Obtenha todas as configurações para integrações de serviços de terceiros

Nesta página

  • Sintaxe
  • Parâmetros do caminho da solicitação
  • Solicitar parâmetros de query
  • Parâmetros do corpo da solicitação
  • Elementos de resposta
  • Exemplo de solicitação
  • Exemplo de resposta

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 grupo de termos mais conhecido ao se referir às descrições. O ponto final permanece conforme indicado no documento.

URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Sintaxe

GET /api/public/v1.0/groups/{GROUP-ID}/integrations

Parâmetros do caminho da solicitação

Parâmetro
necessidade
Descrição

{PROJECT-ID}

Obrigatório

Identificador do projeto.

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.

1

itemsPerPage

número

Opcional

Número de itens a serem devolvidos por página, até um máximo de 500.

100

pretty

booleano

Opcional

Sinalizador que indica se o corpo da resposta deve estar em um prettyprint formato.

false

envelope

booleano

Opcional

Sinalizador que indica se deseja ou não envolver a resposta em um envelope.

Alguns clientes do API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, configure envelope : true na consulta.

Para endpoints que retornam uma lista de resultados, o objeto results é um envelope. O Ops Manager adiciona o campo status ao corpo da resposta.

false

backupJobsEnabledOnly

booleano

Opcional

Sinalizador que indica se os daemon não habilitados para reconhecimento de data center devem ser excluídos da resposta. Defina isso como false para incluir configurações de daemon com o sinalizador backupJobsEnabled definido como false.

true

Parâmetros do corpo da solicitação

Este endpoint não usa parâmetros do corpo da solicitação HTTP.

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 a seu próprio tipo de integração (por exemplo "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:

Serviço, serviço
Resultado

PagerDuty

Um objeto de configuração de integração PagerDuty retornado contém os seguintes campos:

Propriedade
Descrição

type

PAGER_DUTY

serviceKey

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ê:

  • Visualize ou edite o alerta por meio da UI.

  • Consulte as configurações de integração de terceiros por meio da API.

Slack

Um objeto de configuração de integração do Slack retornado contém os seguintes campos:

Propriedade
Descrição

type

SLACK

apiToken

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ê:

  • Visualize ou edite o alerta por meio da UI.

  • Consulte as configurações de integração de terceiros por meio da API.

teamName

Nome da sua equipe. Este campo pode não estar presente com uma integração legada do Slack.

channelName

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

type

DATADOG

apiKey

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ê:

  • Visualize ou edite o alerta por meio da UI.

  • Consulte as configurações de integração de terceiros por meio da API.

HipChat

Um objeto de configuração de integração do HipChat retornado contém os seguintes campos:

Propriedade
Descrição

type

HIP_CHAT

notificationToken

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ê:

  • Visualize ou edite o alerta por meio da UI.

  • Consulte as configurações de integração de terceiros por meio da API.

roomName

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

type

OPS_GENIE

apiKey

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ê:

  • Visualize ou edite o alerta por meio da UI.

  • Consulte as configurações de integração de terceiros por meio da API.

region

Indica qual URL de API usar,US ou EU. O padrão do Opsgenie é US.

Para definir region como EU, você deve definir uma configuração de cliente de opsgenie.api.url.

VictorOps

Um objeto de configuração de integração do VictorOps retornado contém os seguintes campos:

Propriedade
Descrição

type

VICTOR_OPS

apiKey

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ê:

  • Visualize ou edite o alerta por meio da UI.

  • Consulte as configurações de integração de terceiros por meio da API.

O objeto de configuração também pode conter os seguintes campos, dependendo da sua configuração:

Propriedade
Descrição

routingKey

Um campo opcional 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

type

WEBHOOK

url

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.

O objeto de configuração também pode conter os seguintes campos, dependendo da sua configuração:

Propriedade
Descrição

secret

Um campo opcional retornado se o webhook estiver configurado com um segredo.

Equipes da Microsoft

Um objeto de configuração do Microsoft equipe retornado conterá os seguintes campo:

Propriedade
Descrição

type

MICROSOFT_TEAMS

microsoftTeamsWebhookUrl

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

type

PROMETHEUS

username

Seu nome de usuário Prometheus.

listenAddress

O endereço IP e a porta que sua instância Prometheus alcançará.

serviceDiscovery

Indica qual método de descoberta de serviço é usado, file ou http.

scheme

Seu esquema de protocolo Prometheus configurado para solicitações, http ou https. Se você configurar o https, deverá especificar o tlsPemPath.

enabled

Se o seu cluster tem o Prometheus habilitado.

O objeto de configuração também pode conter os seguintes campos, dependendo da sua configuração:

Propriedade
Descrição

tlsPemPassword

Um campo opcional retornado se você tiver uma senha para seu arquivo PEM.

tlsPemPath

Um campo opcional retornado se você tiver um caminho absoluto para seu arquivo PEM.

Exemplo de solicitação

1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2     --header "Accept: application/json" \
3     --include \
4     --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/integrations"

Exemplo de resposta

1{
2  "links": [
3    {
4      "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/integrations?pageNum=1&itemsPerPage=100",
5      "rel": "self"
6    }
7  ],
8  "results": [
9    {
10      "serviceKey": "******7890",
11      "type": "PAGER_DUTY"
12    },
13    {
14      "apiToken": "******7890",
15      "channelName": "My Channel",
16      "teamName": "My Team",
17      "type": "SLACK"
18    },
19  ],
20  "totalCount": 2
21 }

Voltar

Configurações de integração

Próximo

Obter uma configuração