1개의 전역 경고 구성 활성화 또는 비활성화

이 페이지의 내용

필수 역할

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

GLOBAL-ALERT-CONFIG-ID 로 식별되는 하나의 전역 경고 구성을 활성화하거나 비활성화합니다.

필수 역할

다음과 같은 할당된 역할을 사용하여 이 엔드포인트를 성공적으로 호출할 수 있습니다.

요청

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

PATCH /globalAlertConfigs/{GLOBAL-ALERT-CONFIG-ID}

요청 경로 매개변수

이름	유형	필요성	설명
`{GLOBAL-ALERT-CONFIG-ID}`	문자열	필수 사항	활성화하거나 비활성화하려는 전역 경고 구성의 고유 식별자입니다.

요청 쿼리 매개변수

이름

유형

필요성

설명

기본값

pretty

부울

옵션

응답 본문이 프리티프린트 에 있어야 하는지 여부를 나타내는 플래그입니다. 형식.

false

envelope

부울

옵션

응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다.

일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다.

하나의 결과를 반환하는 엔드포인트의 경우 응답 본문에는 다음이 포함됩니다.

이름	설명
`status`	HTTP 응답 코드
`content`	예상되는 응답 본문

false

요청 본문 매개변수

본문 매개변수	유형	필요성	설명
`enabled`	부울	필수 사항	전역 경고 구성의 활성화 또는 비활성화 여부를 토글합니다. 전역 경고 구성을 활성화 하려면 `true` 로 설정합니다. 전역 경고 구성을 비활성화하려면 `false` 로 설정합니다.

응답

이름	유형	설명
`created`	문자열	ISO 8601 의 타임스탬프 경고 구성이 생성된 시점의 UTC 날짜 및 시간 형식입니다.
`enabled`	부울	경고 구성의 활성화 여부를 지정하는 토글입니다.
`eventTypeName`	문자열	이 경고 구성이 Atlas가 경고를 트리거하는 이벤트 유형입니다. 경고를 생성하는 이벤트 유형을 검토하려면 경고 유형을 참조하세요. Ops Manager 감사 로그에 포함된 이벤트의 전체 목록은 감사 이벤트를 참조하세요.
`forAllGroups`	부울	전역 경고 구성을 모든 그룹에 적용할지 여부를 지정하는 토글입니다. 또한 `tags` 배열을 사용하여 특정 그룹을 구성 대상으로 지정할 수 있는지 여부에도 영향을 줍니다. `true` 이면 구성이 모든 그룹에 적용됩니다. `tags` 배열을 통해 특정 그룹을 대상으로 경고 구성을 지정할 수 있습니다. `false` 인 경우 구성은 `groupIds` 배열에 지정된 그룹에만 적용됩니다. `groupIds` 배열에 프로젝트를 하나 이상 지정해야 합니다. 이 경고 구성에는 `tags` 배열을 사용할 수 없습니다.
`groupIds`	문자열 배열	이 경고 구성이 적용되는 그룹의 ID입니다. 이 필드는 `forAllGroups` 이(가) `false`(으)로 설정된 경우에만 적용됩니다.
`id`	문자열	경고 구성의 고유 식별자입니다.
`matchers`	객체 배열	이 전역 경고 구성과 객체를 일치시킬 때 적용할 규칙입니다. MongoDB Ops Manager는 경고 조건에 대해 이러한 모든 규칙과 일치하는 엔터티만 확인합니다. `eventTypeName` 가 호스트, 복제본 세트 또는 샤드 cluster에 대한 이벤트를 지정하는 경우에만 `matchers` 배열을 사용하여 필터링할 수 있습니다.
`matchers.fieldName`	문자열	일치시킬 대상 객체의 필드 이름입니다. 호스트 경고는 이러한 필드를 지원합니다. `HOSTNAME` `PORT` `HOSTNAME_AND_PORT` `REPLICA_SET_NAME` `TYPE_NAME` 복제본 세트 경고는 이러한 필드를 지원합니다. `REPLICA_SET_NAME` `SHARD_NAME` `CLUSTER_NAME` Sharded cluster 경고는 다음과 같은 필드를 지원합니다. `CLUSTER_NAME` `SHARD_NAME` 다른 모든 유형의 경고는 매처를 지원하지 않습니다.
`matchers.operator`	문자열	필드 값을 테스트하는 연산자입니다. 가능한 값은 다음과 같습니다. `EQUALS` `NOT_EQUALS` `CONTAINS` `NOT_CONTAINS` `STARTS_WITH` `ENDS_WITH` `REGEX`
`matchers.value`	문자열	지정된 연산자로 테스트할 값입니다. `matchers.fieldName` 로 설정된 `TYPE_NAME` 경우 다음 값을 일치시킬 수 있습니다. `PRIMARY` `SECONDARY` `STANDALONE` `CONFIG` `MONGOS`
`metricThreshold`	객체	이 경고 구성이 경고를 trigger 하도록 하는 임계값입니다. `eventTypeName` 이(가) `OUTSIDE_METRIC_THRESHOLD`(으)로 설정된 경우에만 표시됩니다.
`metricThreshold.metricName`	문자열	확인할 지표의 이름입니다. `globalAlerts` 리소스 의 `metricName` 필드 와 동일한 값을 지원합니다. 사용 가능한 값 목록은 글로벌 경고의 측정 유형을 참조하세요.
`metricThreshold.mode`	문자열	이 값은 `AVERAGE` 으)로 설정되고 현재 지표 값을 평균으로 계산합니다.
`metricThreshold.operator`	문자열	`metricThreshold.threshold` 에 대해 현재 지표 값을 확인할 때 적용할 연산자입니다. 가능한 값은 다음과 같습니다. `GREATER_THAN` `LESS_THAN`
`metricThreshold.threshold`	숫자	이 경고 구성을 벗어나는 임계값으로 Atlas가 경고를 트리거합니다.
`metricThreshold.units`	문자열	`metricThreshold.threshold` 의 단위입니다. 단위는 메트릭 유형에 따라 다릅니다. 허용되는 값은 다음과 같습니다. `RAW` `BITS` `BYTES` `KILOBITS` `KILOBYTES` `MEGABITS` `MEGABYTES` `GIGABITS` `GIGABYTES` `TERABYTES` `PETABYTES` `MILLISECONDS` `SECONDS` `MINUTES` `HOURS` `DAYS` 예를 예시 메모리 소비를 측정하는 지표에는 `BYTES`, 시간을 측정하는 지표에는 `HOURS` 를 사용할 수 있습니다.
`notifications`	객체 배열	알림 MongoDB Ops Manager는 이 경고 구성에서 설명하는 경고를 감지하면 전송합니다.
`notifications.apiToken`	문자열	Slack API 토큰 또는 Bot 토큰. `SLACK` 알림에만 표시됩니다. 나중에 토큰이 유효하지 않게 되면 MongoDB Ops Manager는 프로젝트 소유자에게 이메일을 보내고 토큰을 제거합니다. API 또는 통합 키가 필요한 타사 통합을 생성한 후 다음과 같은 경우 키가 부분적으로 편집된 상태로 표시됩니다. UI를 통해 경고를 보거나 편집합니다. API 를 통해 타사 통합 설정을 쿼리합니다.
`notifications.channelName`	문자열	Slack 채널 이름입니다. `SLACK` 알림에만 표시됩니다.
`notifications.delayMin`	숫자	경고 조건이 감지된 후 MongoDB Ops Manager가 첫 번째 알림을 보내기 전에 대기할 시간(분)입니다.
`notifications.emailAddress`	문자열	알림을 보낼 이메일 주소입니다. `EMAIL` 알림에만 표시됩니다.
`notifications.emailEnabled`	부울	MongoDB Ops Manager가 이메일 알림을 보낼지 여부를 토글합니다. `GROUP` 및 `USER` 알림에만 존재합니다.
`notifications.intervalMin`	숫자	이 경고 구성이 Atlas가 트리거하는 확인되지 않았거나 해결되지 않은 경고에 대한 연속 알림 사이에 대기할 시간(분)입니다.
notifications.[n] .webhookSecret	문자열	알림을 수락하고 전달하는 Webhook으로 인증하는 데 사용되는 값입니다. Ops Manager는 `notifications.[n].typeName` 을(를) `WEBHOOK` (으)로 설정하거나 다음 중 하나에 해당하는 경우 이 값을 반환합니다. `notification.[n].webhookSecret` 을(를) 비어 있지 않은 문자열로 설정합니다. 관리 콘솔에서 기본값 `webhookSecret` 를 설정하다 합니다. 웹훅 알림을 생성한 후 경고 를 보거나 편집할 때 URL 이 부분적으로 수정되고 시크릿은 완전히 수정됩니다.
notifications.[n] .webhookUrl	문자열	이 알림을 Atlas Triggers 웹훅의 URL 입니다. Ops Manager는 `notifications.[n].typeName` 을(를) `WEBHOOK` (으)로 설정하거나 다음 중 하나에 해당하는 경우 이 값을 반환합니다. `notification.[n].webhookURL` 을(를) 비어 있지 않은 문자열로 설정합니다. 관리 콘솔 페이지에서 기본값 `webhookUrl` 를 설정하다 합니다. 웹훅 알림을 생성한 후 경고 를 보거나 편집할 때 URL 이 부분적으로 수정되고 시크릿은 완전히 수정됩니다.
`notifications.microsoftTeamsWebhookUrl`	문자열	Microsoft Teams 채널 수신 웹훅 URL입니다. `MICROSOFT_TEAMS` 알림에만 표시됩니다. 웹후크 알림에 대한 경고를 보거나 편집할 때 URL은 부분적으로 편집된 상태로 표시되고 비밀번호는 완전히 편집된 상태로 표시됩니다.
`notifications.notificationToken`	문자열	HipChat API 토큰. `HIP_CHAT` 알림에만 표시됩니다. 나중에 토큰이 유효하지 않게 되면 MongoDB Ops Manager는 프로젝트 소유자에게 이메일을 보내고 토큰을 제거합니다. API 또는 통합 키가 필요한 타사 통합을 생성한 후 다음과 같은 경우 키가 부분적으로 편집된 상태로 표시됩니다. UI를 통해 경고를 보거나 편집합니다. API 를 통해 타사 통합 설정을 쿼리합니다.
`notifications.roomName`	문자열	HipChat 채팅방 이름입니다. `HIP_CHAT` 알림에만 표시됩니다.
`notifications.serviceKey`	문자열	PagerDuty 통합 키입니다. `PAGER_DUTY` 알림에만 표시됩니다. 나중에 키가 유효하지 않게 되면 MongoDB Ops Manager는 프로젝트 소유자에게 이메일을 보내고 키를 제거합니다. API 또는 통합 키가 필요한 타사 통합을 생성한 후 다음과 같은 경우 키가 부분적으로 편집된 상태로 표시됩니다. UI를 통해 경고를 보거나 편집합니다. API 를 통해 타사 통합 설정을 쿼리합니다.
`notifications.smsEnabled`	부울	MongoDB Ops Manager가 SMS 알림을 보낼지 여부를 토글합니다. `GROUP` 및 `USER` 알림에만 존재합니다.
`notifications.typeName`	문자열	이 경고 구성의 경고 알림 유형 Atlas Triggers입니다. 가능한 값은 다음과 같습니다. `ADMIN` `GROUP` `USER` `EMAIL` `SMS` ( MongoDB Ops Manager 가 Twilio 통합 을 위해 구성된 경우에만 사용 가능합니다.) `HIPCHAT` `SLACK` `PAGER_DUTY`
`notifications.username`	문자열	알림을 보낼 MongoDB Ops Manager 사용자의 이름입니다. `USER` 알림에만 표시됩니다.
`threshold`	객체	이 경고 구성이 경고를 trigger 하도록 하는 임계값입니다. `eventTypeName` 이 다음 값 중 하나로 설정된 경우에만 표시됩니다. `TOO_FEW_HEALTHY_MEMBERS` `TOO_MANY_UNHEALTHY_MEMBERS`
`threshold.operator`	문자열	`threshold.threshold` 에 대해 현재 지표 값을 확인할 때 적용할 연산자입니다. 가능한 값은 다음과 같습니다. `GREATER_THAN` `LESS_THAN`
`threshold.threshold`	숫자	이 경고 구성을 벗어나는 임계값으로 Atlas가 경고를 트리거합니다.
`tags`	문자열 배열	이 경고 구성과 연결된 태그입니다.
`typeName`	문자열	이 필드는 더 이상 사용되지 않으며 무시됩니다.
`updated`	문자열	ISO 8601 의 타임스탬프 이 경고 구성이 마지막으로 업데이트된 날짜 및 시간 형식(UTC )입니다.

요청 예시

1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2      --header "Accept: application/json" \
3      --header "Content-Type: application/json" \
4      --include \
5      --request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/globalAlertConfigs/{GLOBAL-ALERT-CONFIG-ID}" \
6      --data '{
7        "enabled" : false
8      }'

응답 예시

응답 헤더

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

응답 본문

1 {
2   "created": "2019-10-02T12:34:04Z",
3   "enabled": false,
4   "eventTypeName": "BACKUP_AGENT_DOWN",
5   "forAllGroups": true,
6   "groupIds": [],
7   "id": "{GLOBAL-ALERT-CONFIG-ID}",
8   "links": [
9   ],
10   "matchers": [],
11   "notifications": [
12     {
13       "delayMin": 0,
14       "intervalMin": 60,
15       "typeName": "ADMIN"
16     }
17   ],
18   "tags": [],
19   "typeName": "AGENT",
20   "updated": "2019-10-02T12:34:04Z"
21 }

돌아가기

1개의 전역 경고 구성 업데이트

1개의 전역 경고 구성 삭제

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--include \
5	--request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/globalAlertConfigs/{GLOBAL-ALERT-CONFIG-ID}" \
6	--data '{
7	"enabled" : false
8	}'

1	{
2	"created": "2019-10-02T12:34:04Z",
3	"enabled": false,
4	"eventTypeName": "BACKUP_AGENT_DOWN",
5	"forAllGroups": true,
6	"groupIds": [],
7	"id": "{GLOBAL-ALERT-CONFIG-ID}",
8	"links": [
9	],
10	"matchers": [],
11	"notifications": [
12	{
13	"delayMin": 0,
14	"intervalMin": 60,
15	"typeName": "ADMIN"
16	}
17	],
18	"tags": [],
19	"typeName": "AGENT",
20	"updated": "2019-10-02T12:34:04Z"
21	}