Docs Home

/ /

타사 통합

Docs Home

/ /

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

참고

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

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

구문

GET /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`

요청 본문 매개변수

이 엔드포인트는 HTTP 요청 본문 매개변수를 사용하지 않습니다.

응답 요소

해당 서비스가 구성된 경우 응답은 지정된 타사 통합 구성 객체를 반환합니다. 구성되지 않은 경우 응답은 INTEGRATION_NOT_CONFIGURED 오류를 반환합니다.

각 타사 통합 구성 객체 에는 자체 통합 유형과 동일한 type 속성 (예: "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 파일의 절대 경로가 있는 경우 반환되는 선택적 필드입니다.

요청 예시

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"

응답 예시

{
  "serviceKey": "******7890",
  "type": "PAGER_DUTY"
}

돌아가기

모든 구성 가져오기

구성 만들기