Página inicial do Docs → MongoDB Cloud Manager
Criar uma configuração para uma integração de serviço de terceiros
Nesta página
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://cloud.mongodb.com/api/public/v1.0
Sintaxe
POST /groups/{GROUP-ID}/integrations/{INTEGRATION-TYPE}
Parâmetros do caminho da solicitação
Parâmetro | necessidade | Descrição |
---|---|---|
{PROJECT-ID} | Obrigatório | Identificador do projeto. |
{INTEGRATION-TYPE} | 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. | 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 Para endpoints que retornam uma lista de resultados, o objeto | 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
O corpo da solicitação deve ser uma única visualização de integração (como um objeto de configuração JSON ) para que um único serviço de terceiros seja adicionado ao projeto. Sempre inclua uma propriedade type
igual ao serviço de terceiros INTEGRATION_TYPE
.
Serviço, serviço | Opções de configuração | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
PagerDuty | Você deve fornecer os seguintes campos ao configurar uma integração PagerDuty:
| ||||||||||||||||||||||
Slack | ImportanteAs integrações do Slack agora usam o método de verificação OAuth2 e devem ser inicialmente configuradas, ou atualizadas a partir de uma integração legada, por meio da página de integrações de serviços de terceiros do MongoDB Atlas. Em breve, os tokens legados não serão mais suportados. Você deve fornecer os seguintes campos ao reconfigurar uma integração existente do Slack:
Você também pode incluir os seguintes campos:
| ||||||||||||||||||||||
Opsgenie | Você deve fornecer os seguintes campos ao configurar uma integração Opsgenie:
| ||||||||||||||||||||||
VictorOps | Você deve fornecer os seguintes campos ao configurar uma integração VictorOps:
Você também pode incluir os seguintes campos:
| ||||||||||||||||||||||
Configurações do webhook | Você deve fornecer os seguintes campos ao definir as configurações do webhook:
Você também pode incluir os seguintes campos:
| ||||||||||||||||||||||
Equipes da Microsoft | Você deve fornecer os seguintes campo ao configurar uma integração do Microsoft equipe:
| ||||||||||||||||||||||
Prometeu(a) | Você deve fornecer os seguintes campos ao configurar uma integração Prometheus:
Você também pode incluir os seguintes campos:
|
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:
Serviço, serviço | Resultado | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
PagerDuty | Um objeto de configuração de integração PagerDuty retornado contém os seguintes campos:
| ||||||||||||||||||||
Slack | Um objeto de configuração de integração do Slack retornado contém os seguintes campos:
| ||||||||||||||||||||
Opsgenie | Um objeto de configuração de integração Opsgenie retornado contém os seguintes campos:
| ||||||||||||||||||||
VictorOps | Um objeto de configuração de integração do VictorOps retornado contém os seguintes campos:
O objeto de configuração também pode conter os seguintes campos, dependendo da sua configuração:
| ||||||||||||||||||||
Configurações do webhook | Um objeto de configuração do webhook retornado contém os seguintes campos:
O objeto de configuração também pode conter os seguintes campos, dependendo da sua configuração:
| ||||||||||||||||||||
Equipes da Microsoft | Um objeto de configuração do Microsoft equipe retornado conterá os seguintes campo:
| ||||||||||||||||||||
Prometeu(a) | Um objeto de configuração Prometheus retornado conterá os seguintes campos:
O objeto de configuração também pode conter os seguintes campos, dependendo da sua configuração:
|
Exemplo de solicitação
1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ 2 --header "Accept: application/json" \ 3 --header "Content-Type: application/json" \ 4 --include \ 5 --request POST "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/integrations/SLACK" \ 6 --data ' 7 { 8 "type": "SLACK", 9 "apiToken": "1234567890", 10 "teamName": "My Team" 11 }'
Exemplo de resposta
1 { 2 "links": [ 3 { 4 "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/integrations/SLACK?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 }