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
GET /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
Este endpoint não usa parâmetros do corpo da solicitação HTTP.
Elementos de resposta
A resposta retorna o objeto de configuração de integração de terceiros especificado se esse serviço tiver sido configurado. Se não tiver sido configurado, a resposta retornará um erro INTEGRATION_NOT_CONFIGURED .
Cada objeto de configuração de integração de terceiros inclui uma propriedade type igual ao seu próprio tipo de integração (como "type": "PAGER_DUTY"). 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" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/integrations/PAGER_DUTY"Exemplo de resposta
{ "serviceKey": "******7890", "type": "PAGER_DUTY"}