조회¶
GET /api/v1/issue/notification_policy/{issue_notification_policy_uuid}/get
개요¶
알림 정책 한 건과 연결된 일정, 채널, 생성/수정 주체를 조회합니다.
호출 전 준비 및 사용 단계¶
알림 정책 목록에서 정책 uuid를 복사하여 경로에 넣고, extend의 각 알림 유형과 에스컬레이션 설정을 조회합니다. 수정 전에 name, notificationScheduleUUIDs 및 extend의 대상 전체 값을 저장합니다. 일정 UUID는 relNotificationScheduleInfos[].uuid에서 가져옵니다. 상세 조회의 일정은 원본 엔터티 설정으로, 목록에 있는 effectiveTimeInfos가 추가되지 않습니다. 정책은 콘솔에서 대상 채널에 연결하고 유효한 알림 일정에 연결해야 합니다. 실제 수신자는 일정의 시간대, 당일 시간 범위, 유효 기간, 로테이션 및 알림 대상에 따라 결정됩니다. 정책을 저장하는 것만으로는 테스트 알림이 즉시 발송되지 않습니다.
경로 파라미터¶
| 파라미터명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| issue_notification_policy_uuid | string | Y | 현재 워크스페이스의 알림 정책 UUID이며 일정 UUID가 아닙니다. 예시: inpy_example가져오기 또는 입력 방법: 알림 정책 목록의 content.data[].uuid 또는 생성 응답의 content.uuid에서 가져옵니다. |
요청 헤더¶
| 파라미터명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예시: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
파라미터 추가 설명¶
에스컬레이션 규칙의 트리거 여부는 Issue 생성 시간, 현재 상태, 담당자, 연결된 이벤트 수, 예약 작업 및 일정의 유효 대상에 따라 달라지므로, 저장된 JSON만으로 메시지가 발송되었다고 판단할 수 없습니다.
요청 예시¶
curl --get 'https://openapi.guance.com/api/v1/issue/notification_policy/inpy_example/get' \
-H 'DF-API-KEY: <DF-API-KEY>'
응답¶
HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content.id | integer | 저장된 정책의 레코드 번호이며, 작업에는 uuid를 사용합니다. |
| content.uuid | string | 알림 정책 UUID이며 inpy_로 시작합니다. |
| content.workspaceUUID | string | 소속 워크스페이스 UUID입니다. |
| content.name | string | 정책 이름입니다. |
| content.status | integer | 레코드 상태이며 0은 활성, 2는 비활성, 3은 삭제입니다. 목록에는 삭제되지 않은 활성 및 비활성 정책이 포함됩니다. |
| content.creator | string | 생성 호출 주체입니다. |
| content.updator | string | 최근 수정 주체이며, 수정되지 않은 경우 빈 문자열입니다. |
| content.createAt | integer | 생성 시간, Unix 초. |
| content.updateAt | integer | 수정 시간, Unix 초이며, 수정되지 않은 경우 -1입니다. |
| content.deleteAt | integer | 삭제 시간, Unix 초이며, 삭제되지 않은 경우 -1입니다. |
| content.extend | object | 저장된 알림 범위와 에스컬레이션 규칙이며 {}일 수 있습니다. |
| content.extend.notifyTypes | array<string> |
활성화된 액션 유형입니다. |
| content.extend.notifyTypes[] | string | 개별 액션 유형이며, 구체적인 동작은 파라미터 표를 참고하십시오. |
| content.extend.upgradeCfg | object | 트리거 유형별로 저장된 규칙입니다. |
| content.extend.upgradeCfg.noManager | object | Issue 생성 시 유효한 담당자가 없어 담당자 없음 후보가 되고 상태가 Open/Working/Pending이면 Issue 생성 시점부터 대기합니다. 기존 Issue에서 담당자만 제거해도 후보로 다시 진입한다고 보장하지 않습니다. 양의 정수 초를 입력하며 60의 배수여야 합니다. 활성화 유형은 issueUpgrade.noManager이며, 설정하지 않으면 생략됩니다. |
| content.extend.upgradeCfg.noManager.duration | integer | 최초 대기 시간(초)입니다. |
| content.extend.upgradeCfg.noManager.notifyType | string | once 또는 cycle이며, 값이 저장되지 않은 경우 once로 처리합니다. |
| content.extend.upgradeCfg.noManager.cycleDuration | integer | 반복 간격(초)이며 cycle 모드에서 사용합니다. |
| content.extend.upgradeCfg.noManager.cycleTimes | integer | 반복 트리거 총 횟수 상한으로 1~30이며 최초 회차를 포함합니다. |
| content.extend.upgradeCfg.processTimeout | object | Issue가 Open/Working 상태로 완료되지 않고 지속된 시간입니다. 최초에는 생성 시점부터 계산하며, Pending/Resolved/Closed에서 처리 상태로 다시 진입하면 재진입 후 상태 기록 시점부터 계산합니다. 활성화 유형은 issueUpgrade.processTimeout이며, 설정하지 않으면 생략됩니다. |
| content.extend.upgradeCfg.processTimeout.duration | integer | 최초 대기 시간(초)입니다. |
| content.extend.upgradeCfg.processTimeout.notifyType | string | once 또는 cycle이며, 값이 저장되지 않은 경우 once로 처리합니다. |
| content.extend.upgradeCfg.processTimeout.cycleDuration | integer | 반복 간격(초)이며 cycle 모드에서 사용합니다. |
| content.extend.upgradeCfg.processTimeout.cycleTimes | integer | 반복 트리거 총 횟수 상한으로 1~30이며 최초 회차를 포함합니다. |
| content.extend.upgradeCfg.openProcessTimeout | object | Issue가 Open 상태를 유지하는 경우에만 적용되며, 마지막 상태 변경 시간부터 계산합니다. 상태 기록이 없으면 생성 시간부터 계산합니다. 활성화 유형은 issueUpgrade.processTimeout이며, 설정하지 않으면 생략됩니다. |
| content.extend.upgradeCfg.openProcessTimeout.duration | integer | 최초 대기 시간(초)입니다. |
| content.extend.upgradeCfg.openProcessTimeout.notifyType | string | once 또는 cycle이며, 값이 저장되지 않은 경우 once로 처리합니다. |
| content.extend.upgradeCfg.openProcessTimeout.cycleDuration | integer | 반복 간격(초)이며 cycle 모드에서 사용합니다. |
| content.extend.upgradeCfg.openProcessTimeout.cycleTimes | integer | 반복 트리거 총 횟수 상한으로 1~30이며 최초 회차를 포함합니다. |
| content.extend.upgradeCfg.eventStorm | object | Issue에 기록된 eventCount가 exceedTimes를 엄격히 초과하면 트리거됩니다. Open/Working 상태로 제한하지 않으므로 완료된 Issue도 수량 조건을 충족할 수 있습니다. 활성화 유형은 issueUpgrade.eventStorm이며, 설정하지 않으면 생략됩니다. |
| content.extend.upgradeCfg.eventStorm.exceedTimes | integer | 수량 임계값이며 eventCount가 엄격히 초과해야 트리거됩니다. |
| content.extend.upgradeCfg.eventStorm.notifyType | string | once 또는 cycle이며, 값이 저장되지 않은 경우 once로 처리합니다. |
| content.extend.upgradeCfg.eventStorm.cycleDuration | integer | 반복 간격(초)이며 cycle 모드에서 사용합니다. |
| content.extend.upgradeCfg.eventStorm.cycleTimes | integer | 반복 트리거 총 횟수 상한으로 1~30이며 최초 회차를 포함합니다. |
| content.extend.기타 필드 | JSON | 소스에서 저장된 기타 확장 필드이며, 모두 알림 동작을 제어할 수 있는 것은 아닙니다. |
| content.relNotificationScheduleInfos | array<object> |
연결된 유효 일정 객체입니다. 목록에는 포맷된 유효 기간이 추가로 포함되지만, 상세 조회는 원본 일정 설정만 제공합니다. |
| content.relNotificationScheduleInfos[].id | integer | 데이터베이스 레코드 번호이며, 일정 작업에는 uuid를 사용합니다. |
| content.relNotificationScheduleInfos[].uuid | string | 일정 UUID로, 조회, 수정, 삭제 및 알림 정책 참조에 사용됩니다. |
| content.relNotificationScheduleInfos[].workspaceUUID | string | 소속 워크스페이스 UUID입니다. |
| content.relNotificationScheduleInfos[].name | string | 일정 이름입니다. |
| content.relNotificationScheduleInfos[].timezone | string | 이 일정에서 당일 시간 범위와 적용 날짜를 해석하는 데 사용하는 IANA 시간대입니다. |
| content.relNotificationScheduleInfos[].start | string | 당일 시작 시각 HH:MM. |
| content.relNotificationScheduleInfos[].end | string | 당일 종료 시각 HH:MM이며, 종료 분의 마지막 초까지 유효합니다. |
| content.relNotificationScheduleInfos[].notifyTargets | array<string> |
순서대로 저장된 멤버, 알림 대상 UUID 또는 이메일입니다. |
| content.relNotificationScheduleInfos[].notifyTargets[] | string | acnt_ 계정, notify_ 알림 대상 또는 이메일 문자열입니다. |
| content.relNotificationScheduleInfos[].extend | object | 확장 설정이며, 설정하지 않으면 {}일 수 있습니다. |
| content.relNotificationScheduleInfos[].extend.enableRotateNotification | boolean | 로테이션 사용 여부이며, 기본값은 false입니다. |
| content.relNotificationScheduleInfos[].extend.rotationCycle | string | 로테이션 사용 시 주기입니다. day는 일 단위, week는 월요일 기준 주 단위, month는 자연월 단위, workDay는 평일만 일 단위, weekend는 주말만 일 단위입니다. 공휴일은 인식하지 않으며, 설정하지 않으면 생략할 수 있습니다. |
| content.relNotificationScheduleInfos[].extend.effectiveTime | object | 전체 유효 기간이며, 설정하지 않으면 생략할 수 있습니다. |
| content.relNotificationScheduleInfos[].extend.effectiveTime.start | integer | 유효 기간 시작 Unix 초이며, 0이거나 생략하면 제한하지 않습니다. |
| content.relNotificationScheduleInfos[].extend.effectiveTime.end | integer | 유효 기간 종료 Unix 초이며, 0이거나 생략하면 제한하지 않습니다. |
| content.relNotificationScheduleInfos[].rotationUpdateAt | integer | 로테이션 계산의 시작 시간(Unix 초)입니다. 로테이션 관련 설정을 변경하면 재설정됩니다. |
| content.relNotificationScheduleInfos[].status | integer | 레코드 상태이며 활성 레코드는 0입니다. |
| content.relNotificationScheduleInfos[].creator | string | 생성 호출 주체입니다. |
| content.relNotificationScheduleInfos[].updator | string | 최근 수정 주체이며, 수정되지 않은 경우 빈 문자열입니다. |
| content.relNotificationScheduleInfos[].createAt | integer | 생성 시간, Unix 초. |
| content.relNotificationScheduleInfos[].updateAt | integer | 수정 시간, Unix 초이며, 수정되지 않은 경우 -1입니다. |
| content.relNotificationScheduleInfos[].deleteAt | integer | 삭제 시간, Unix 초이며, 삭제되지 않은 경우 -1입니다. |
| content.relChannelInfos | array<object> |
이 정책을 참조하는 채널 객체입니다. |
| content.relChannelInfos[].id | integer | 채널 레코드 번호입니다. |
| content.relChannelInfos[].uuid | string | 채널 UUID로, 수정, 삭제 또는 구독에 사용됩니다. |
| content.relChannelInfos[].workspaceUUID | string | 채널이 속한 워크스페이스입니다. |
| content.relChannelInfos[].name | string | 채널 이름입니다. default는 기본 채널을 의미합니다. |
| content.relChannelInfos[].description | string | 채널 설명입니다. |
| content.relChannelInfos[].notifyTarget | array<string> |
이 채널에 직접 설정된 알림 대상 UUID입니다. |
| content.relChannelInfos[].notifyTarget[] | string | 개별 알림 대상 UUID입니다. |
| content.relChannelInfos[].notifyUpgradeCfg | object | 에스컬레이션 알림 설정이며, 설정하지 않으면 빈 객체입니다. |
| content.relChannelInfos[].notifyUpgradeCfg.triggerTime | integer | 에스컬레이션 알림을 트리거하는 대기 시간(초)입니다. |
| content.relChannelInfos[].notifyUpgradeCfg.notifyTarget | array<string> |
에스컬레이션 알림 대상 UUID 목록입니다. |
| content.relChannelInfos[].notifyUpgradeCfg.notifyTarget[] | string | 에스컬레이션 알림 대상 UUID입니다. |
| content.relChannelInfos[].status | integer | 레코드 상태이며 정상은 0입니다. |
| content.relChannelInfos[].creator | string | 생성 호출 주체입니다. |
| content.relChannelInfos[].updator | string | 최근 수정 주체이며, 수정되지 않은 경우 빈 문자열일 수 있습니다. |
| content.relChannelInfos[].createAt | integer | 생성 시간, Unix 초. |
| content.relChannelInfos[].updateAt | integer | 수정 시간, Unix 초이며, 수정되지 않은 경우 -1입니다. |
| content.relChannelInfos[].deleteAt | integer | 삭제 시간, Unix 초이며, 삭제되지 않은 경우 -1입니다. |
| content.creatorInfo | object | 생성/수정 주체의 해석 가능한 계정 정보입니다. API Key는 자연인 멤버가 아니므로 목록에서는 null을 반환할 수 있고, 상세에서는 빈 객체일 수 있습니다. 아래 필드는 주체에 따라 선택적입니다. |
| content.creatorInfo.uuid | string | 계정 UUID입니다. |
| content.creatorInfo.status | integer | 계정 레코드 상태입니다. |
| content.creatorInfo.wsAccountStatus | integer | 워크스페이스 내 계정 상태입니다. |
| content.creatorInfo.username | string | 로그인 이름입니다. |
| content.creatorInfo.name | string | 표시 이름입니다. |
| content.creatorInfo.iconUrl | string | 프로필 이미지 URL이며 생략할 수 있습니다. |
| content.creatorInfo.email | string | 이메일 또는 API Key 주체 식별자입니다. |
| content.creatorInfo.mobile | string | 휴대폰 번호이며 비어 있을 수 있습니다. |
| content.creatorInfo.countryCode | string | 국가/지역 코드이며 생략할 수 있습니다. |
| content.creatorInfo.acntWsNickname | string | 워크스페이스 닉네임이며 생략할 수 있습니다. |
| content.updatorInfo | object | 생성/수정 주체의 해석 가능한 계정 정보입니다. API Key는 자연인 멤버가 아니므로 목록에서는 null을 반환할 수 있고, 상세에서는 빈 객체일 수 있습니다. 아래 필드는 주체에 따라 선택적입니다. |
| content.updatorInfo.uuid | string | 계정 UUID입니다. |
| content.updatorInfo.status | integer | 계정 레코드 상태입니다. |
| content.updatorInfo.wsAccountStatus | integer | 워크스페이스 내 계정 상태입니다. |
| content.updatorInfo.username | string | 로그인 이름입니다. |
| content.updatorInfo.name | string | 표시 이름입니다. |
| content.updatorInfo.iconUrl | string | 프로필 이미지 URL이며 생략할 수 있습니다. |
| content.updatorInfo.email | string | 이메일 또는 API Key 주체 식별자입니다. |
| content.updatorInfo.mobile | string | 휴대폰 번호이며 비어 있을 수 있습니다. |
| content.updatorInfo.countryCode | string | 국가/지역 코드이며 생략할 수 있습니다. |
| content.updatorInfo.acntWsNickname | string | 워크스페이스 닉네임이며 생략할 수 있습니다. |
| content.declaration | object 또는 null | 워크스페이스 공통 선언입니다. |
{
"code": 200,
"content": {
"id": 42,
"uuid": "inpy_example",
"workspaceUUID": "wksp_example",
"name": "운영 인시던트 알림",
"extend": {
"notifyTypes": [
"issue.add",
"issue.modify",
"issueReply.add",
"issueUpgrade.noManager",
"issueUpgrade.processTimeout",
"issueUpgrade.eventStorm"
],
"upgradeCfg": {
"noManager": {
"duration": 600,
"notifyType": "once"
},
"processTimeout": {
"duration": 1800,
"notifyType": "cycle",
"cycleDuration": 600,
"cycleTimes": 3
},
"openProcessTimeout": {
"duration": 900,
"notifyType": "once"
},
"eventStorm": {
"exceedTimes": 60,
"notifyType": "once"
}
}
},
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785430800,
"updateAt": -1,
"deleteAt": -1,
"relNotificationScheduleInfos": [],
"relChannelInfos": [],
"creatorInfo": {},
"updatorInfo": {},
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참고하십시오.
| HTTP 상태 | errorCode | 트리거 조건 | 메시지 또는 응답 설명 | 처리 방식 |
|---|---|---|---|---|
| 404 | ft.ObjectNotExists | 정책이 존재하지 않거나, 삭제되었거나, 현재 API Key 워크스페이스에 속하지 않음 | 지정한 객체가 존재하지 않습니다 | 알림 정책 목록에서 현재 워크스페이스 UUID를 다시 가져옵니다. |
| 500 | ft.InternalServerError | 정책 또는 연결된 정보 조회 실패 | 내부 오류 | 잠시 후 다시 시도하십시오. 계속 실패하면 traceId를 제공하십시오. |