타사 서비스 통합을 위한 구성 생성

이 페이지의 내용

구문

요청 경로 매개변수
요청 쿼리 매개변수
요청 본문 매개변수
응답 요소
요청 예시
응답 예시

Cloud Manager는 2024년 8월 30일부터 더 이상 MongoDB 3.6 및 4.0에 대한 자동화, 백업 및 모니터링을 지원하지 않습니다. MongoDB 배포를 업그레이드하거나 Atlas로 마이그레이션하세요.

Cloud Manager 에 대한 프로그래밍 방식의 액세스 를 위한 OAuth 2.0 인증 은 Preview 기능 으로 제공됩니다.: 기능 및 해당 설명서는 미리 보기 기간에 언제든지 변경될 수 있습니다. OAuth 2.0 인증 을 사용하려면 Cloud Manager 공개 API 에 대한 요청에 사용할 서비스 계정 을 만듭니다.

참고

그룹과 프로젝트는 동의어입니다. {PROJECT-ID}는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 이 페이지에서는 설명에 대해 얘기할 때 더욱 친숙한 용어 그룹을 사용합니다. 엔드포인트는 문서에 명시된 대로 유지됩니다.

기본 URL: https://cloud.mongodb.com/api/public/v1.0

구문

POST /groups/{GROUP-ID}/integrations/{INTEGRATION-TYPE}

요청 경로 매개변수

Parameter	필요성	설명
`{PROJECT-ID}`	필수 사항	프로젝트 식별자입니다.
`{INTEGRATION-TYPE}`	필수 사항	타사 서비스 식별자입니다. 허용되는 값은 다음과 같습니다. `PAGER_DUTY` `SLACK` `NEW_RELIC` `OPS_GENIE` `VICTOR_OPS` `WEBHOOK` `PROMETHEUS`

요청 쿼리 매개변수

이름	유형	필요성	설명	기본값
pageNum	숫자	옵션	결과의 하위 섹션을 반환하는 1부터 시작하는 정수입니다.	`1`
itemsPerPage	숫자	옵션	페이지당 반환할 항목 수. 최대 500개까지 가능합니다.	`100`
pretty	부울	옵션	응답 본문을 프리티프린트 에 넣어야 하는지 여부를 나타내는 플래그입니다. 형식.	`false`
envelope	부울	옵션	응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 `envelope : true`를 설정합니다. 결과 목록을 반환하는 엔드포인트의 경우 `content` 객체는 엔벨로프입니다. Cloud Manager가 `status` 필드를 응답 본문에 추가합니다.	`false`
backupJobsEnabledOnly	부울	옵션	데이터베이스 백업에 활성화되지 않은 데몬을 응답에서 제외할지 여부를 나타내는 플래그입니다. `backupJobsEnabled` 플래그가 `false` 로 설정된 daemon 구성을 포함하려면 이 값을 `false` 로 설정합니다.	`true`

요청 본문 매개변수

요청 본문은 프로젝트 에 추가할 단일 타사 서비스에 대한 단일 통합 뷰(예: JSON 구성 객체 )여야 합니다. 항상 타사 서비스 INTEGRATION_TYPE 과 동일한 type 속성 을 포함합니다.

서비스

구성 옵션

PagerDuty

PagerDuty 통합을 구성할 때 다음 필드를 제공해야 합니다.

속성

설명

type

PAGER_DUTY

serviceKey

서비스 키.

모든 새 PagerDuty 키는 이벤트 API v 를2 사용합니다. . Events API v1 키가 있는 경우 Cloud Manager 에서 해당 키를 계속 사용할 수 있습니다.

API 또는 통합 키가 필요한 타사 통합을 생성한 후 다음과 같은 경우 키가 부분적으로 편집된 상태로 표시됩니다.

UI를 통해 경고를 보거나 편집합니다.
API 를 통해 타사 통합 설정을 쿼리합니다.

Slack

중요: 이제 Slack 통합은 OAuth2 확인 방법을 사용하며, MongoDB Atlas 타사 서비스 통합 페이지 를 통해 초기에 구성하거나 레거시 통합에서 업데이트해야 합니다. 레거시 토큰은 곧 더 이상 지원되지 않습니다.

기존 Slack 통합을 재구성할 때 다음 필드를 제공해야 합니다.

속성	설명
`type`	`SLACK`
`apiToken`	API 토큰. API 또는 통합 키가 필요한 타사 통합을 생성한 후 다음과 같은 경우 키가 부분적으로 편집된 상태로 표시됩니다. UI를 통해 경고를 보거나 편집합니다. API 를 통해 타사 통합 설정을 쿼리합니다.
`teamName`	팀 이름입니다.

다음 필드를 포함할 수도 있습니다.

속성	설명
`channelName`	재구성할 채널 이름입니다.

Opsgenie

Opsgenie 통합을 구성할 때 다음 필드를 제공해야 합니다.

속성	설명
`type`	`OPS_GENIE`
`apiKey`	API 키. API 또는 통합 키가 필요한 타사 통합을 생성한 후 다음과 같은 경우 키가 부분적으로 편집된 상태로 표시됩니다. UI를 통해 경고를 보거나 편집합니다. API 를 통해 타사 통합 설정을 쿼리합니다.
`region`	사용할 API URL `US` 또는 `EU`)을 나타냅니다. Opsgenie의 기본값은 `US` 입니다.

VictorOps

VictorOps 통합을 구성할 때 다음 필드를 제공해야 합니다.

속성	설명
`type`	`VICTOR_OPS`
`apiKey`	API 키. API 또는 통합 키가 필요한 타사 통합을 생성한 후 다음과 같은 경우 키가 부분적으로 편집된 상태로 표시됩니다. UI를 통해 경고를 보거나 편집합니다. API 를 통해 타사 통합 설정을 쿼리합니다.

다음 필드를 포함할 수도 있습니다.

속성	설명
`routingKey`	라우팅 키의 선택적 필드입니다.

웹훅 설정

웹훅 설정을 구성할 때 다음 필드를 제공해야 합니다.

속성	설명
`type`	`WEBHOOK`
`url`	웹훅 URL입니다.

다음 필드를 포함할 수도 있습니다.

속성	설명
`secret`	웹훅 시크릿을 위한 선택적 필드입니다. 웹훅 알림을 생성한 후 경고 를 보거나 편집할 때 URL 이 부분적으로 수정되고 시크릿은 완전히 수정됩니다.

마이크로소프트 팀즈

Microsoft 팀 통합을 구성할 때 다음 필드를 제공해야 합니다.

속성	설명
`type`	`MICROSOFT_TEAMS`
`microsoftTeamsWebhookUrl`	Microsoft 팀 수신 웹훅 URL. 웹후크 알림에 대한 경고를 보거나 편집할 때 URL은 부분적으로 편집된 상태로 표시되고 비밀번호는 완전히 편집된 상태로 표시됩니다.

프로메테우스

Prometheus 통합을 구성할 때 다음 필드를 제공해야 합니다.

속성	설명
`type`	`PROMETHEUS`
`username`	Prometheus 사용자 이름입니다.
`password`	Prometheus 비밀번호입니다.
`listenAddress`	Prometheus 인스턴스가 연결할 IP 주소 및 포트입니다.
`serviceDiscovery`	사용되는 서비스 검색 메서드( `file` 또는 `http`)를 나타냅니다.
`scheme`	`http` 또는 `https` 요청에 대해 구성된 Prometheus 프로토콜 체계. `https` 를 구성하는 경우 `tlsPemPath` 을 지정해야 합니다.
`enabled`	cluster에 Prometheus가 활성화되어 있는지 여부.

다음 필드를 포함할 수도 있습니다.

속성	설명
`tlsPemPassword`	PEM 파일의 비밀번호에 대한 선택적 필드입니다.
`tlsPemPath`	PEM 파일의 절대 경로에 대한 선택적 필드입니다.

응답 요소

응답에는 프로젝트에 대한 모든 타사 통합 구성을 객체로 나열하는 results 배열과 프로젝트와 통합된 서비스의 totalCount 가 포함됩니다.

각 타사 통합 구성 객체에는 자체 통합 유형과 동일한 type 속성이 포함되어 있습니다(PagerDuty 서비스의 경우 "type": "PAGER_DUTY" ). 또한 각 타사 서비스 구성 객체는 해당 서비스와 관련된 세부 정보를 제공합니다. 다음은 각 타사 서비스 구성 객체에 대해 반환되는 속성 목록입니다.

서비스

결과

PagerDuty

반환된 PagerDuty 통합 구성 객체에는 다음 필드가 포함되어 있습니다.

속성	설명
`type`	`PAGER_DUTY`
`serviceKey`	서비스 키. API 또는 통합 키가 필요한 타사 통합을 생성한 후 다음과 같은 경우 키가 부분적으로 편집된 상태로 표시됩니다. UI를 통해 경고를 보거나 편집합니다. API 를 통해 타사 통합 설정을 쿼리합니다.

Slack

반환된 Slack 통합 구성 객체에는 다음 필드가 포함됩니다.

속성	설명
`type`	`SLACK`
`apiToken`	API 토큰. API 또는 통합 키가 필요한 타사 통합을 생성한 후 다음과 같은 경우 키가 부분적으로 편집된 상태로 표시됩니다. UI를 통해 경고를 보거나 편집합니다. API 를 통해 타사 통합 설정을 쿼리합니다.
`teamName`	팀 이름입니다. 이 필드는 레거시 Slack 통합에는 없을 수 있습니다.
`channelName`	구성된 Slack 채널 이름입니다. 값이 설정되지 않은 경우 빈 문자열입니다.

Opsgenie

반환된 Opsgenie 통합 구성 객체에는 다음 필드가 포함됩니다.

속성	설명
`type`	`OPS_GENIE`
`apiKey`	API 키. API 또는 통합 키가 필요한 타사 통합을 생성한 후 다음과 같은 경우 키가 부분적으로 편집된 상태로 표시됩니다. UI를 통해 경고를 보거나 편집합니다. API 를 통해 타사 통합 설정을 쿼리합니다.
`region`	사용할 API URL `US` 또는 `EU`)을 나타냅니다. Opsgenie의 기본값은 `US` 입니다.

VictorOps

반환된 VictorOps 통합 구성 객체에는 다음 필드가 포함됩니다.

속성	설명
`type`	`VICTOR_OPS`
`apiKey`	API 키. API 또는 통합 키가 필요한 타사 통합을 생성한 후 다음과 같은 경우 키가 부분적으로 편집된 상태로 표시됩니다. UI를 통해 경고를 보거나 편집합니다. API 를 통해 타사 통합 설정을 쿼리합니다.

구성 객체에는 구성에 따라 다음 필드가 포함될 수도 있습니다.

속성	설명
`routingKey`	라우팅 키를 구성한 경우 반환되는 선택적 필드입니다.

웹훅 설정

반환된 웹훅 구성 객체에는 다음 필드가 포함됩니다.

속성	설명
`type`	`WEBHOOK`
`url`	웹훅 URL입니다. 웹훅 알림을 생성한 후 경고 를 보거나 편집할 때 URL 이 부분적으로 수정되고 시크릿은 완전히 수정됩니다.

구성 객체에는 구성에 따라 다음 필드가 포함될 수도 있습니다.

속성	설명
`secret`	웹훅이 시크릿으로 구성된 경우 반환되는 선택적 필드입니다.

마이크로소프트 팀즈

반환된 Microsoft 팀 구성 객체에는 다음 필드가 포함됩니다.

속성	설명
`type`	`MICROSOFT_TEAMS`
`microsoftTeamsWebhookUrl`	Microsoft 팀 수신 웹훅 URL. 웹후크 알림에 대한 경고를 보거나 편집할 때 URL은 부분적으로 편집된 상태로 표시되고 비밀번호는 완전히 편집된 상태로 표시됩니다.

프로메테우스

반환된 Prometheus 구성 객체에는 다음 필드가 포함됩니다.

속성	설명
`type`	`PROMETHEUS`
`username`	Prometheus 사용자 이름입니다.
`listenAddress`	Prometheus 인스턴스가 연결할 IP 주소 및 포트입니다.
`serviceDiscovery`	사용되는 서비스 검색 메서드( `file` 또는 `http`)를 나타냅니다.
`scheme`	`http` 또는 `https` 요청에 대해 구성된 Prometheus 프로토콜 체계. `https` 를 구성하는 경우 `tlsPemPath` 을 지정해야 합니다.
`enabled`	cluster에 Prometheus가 활성화되어 있는지 여부.

구성 객체에는 구성에 따라 다음 필드가 포함될 수도 있습니다.

속성	설명
`tlsPemPassword`	PEM 파일의 비밀번호가 있는 경우 반환되는 선택적 필드입니다.
`tlsPemPath`	PEM 파일의 절대 경로가 있는 경우 반환되는 선택적 필드입니다.

요청 예시

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      }'

응답 예시

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 }

돌아가기

타사 서비스 통합 구성 가져오기

타사 서비스 통합을 위한 구성 업데이트

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	}'

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	}