만료 알림 설정

현재 Apigee Edge 문서가 표시되고 있습니다.
Apigee X 문서로 이동 정보

TLS 만료 알림을 사용하면 환경의 TLS 인증서가 곧 만료될 때 알림을 표시할 수 있습니다.

TLS 인증서 정보

TLS (전송 계층 보안)는 브라우저나 앱과 같은 웹 서버와 웹 클라이언트 간에 암호화된 링크를 설정하기 위한 표준 보안 기술입니다. 암호화된 링크는 서버와 클라이언트 간에 전달되는 모든 데이터를 비공개로 유지합니다.

TLS 인증서는 TLS 트랜잭션의 항목을 식별하는 디지털 파일입니다. Edge는 TLS 인증서를 사용하여 다음에 대해 TLS를 구성합니다.

TLS 인증서에는 만료일이 포함됩니다. TLS 인증서가 만료되면 인증서를 업데이트할 때까지 TLS 연결이 실패합니다. 즉, 인증서를 업데이트할 때까지 API에 대한 모든 요청이 실패합니다.

만료 알림 정보

인증서가 만료되거나 API에 대한 요청이 실패할 때까지 기다리는 대신 만료 알림을 사용하여 환경의 TLS 인증서가 곧 만료될 때 알림을 보내세요. 알림이 트리거된 후에는 고객에게 서비스가 중단되지 않도록 인증서를 업데이트할 수 있습니다.

알림을 구성할 때 개별 인증서가 아닌 특정 환경을 지정합니다. 배포된 인증서가 지정된 기간 내에 만료되도록 예약되면 알림이 트리거됩니다.

만료 알림이 발생하도록 설정할 수 있습니다.

  • 인증서 만료 1일 전
  • 인증서 만료 14일 전
  • 인증서 만료 30일 전
알림에 관한 자세한 내용은 알림 및 알림 설정을 참고하세요.

만료 알림 및 알림 추가

만료 알림 및 알림을 추가하려면 다음 안내를 따르세요.
  1. Edge UI에서 분석 > 경고 규칙을 클릭합니다.
  2. +경고를 클릭합니다.
  3. 알림에 대한 다음과 같은 일반 정보를 입력합니다.
    필드 설명
    알림 이름 경고의 이름입니다. 트리거를 올바르게 설명하고 유용한 이름을 사용합니다. 이름은 128자(영문 기준)를 초과할 수 없습니다.
    설명 알림에 대한 설명입니다.
    알림 유형 TLS Expiry(TLS 만료)를 선택합니다. 자세한 내용은 알림 유형 정보를 참고하세요.
    환경 드롭다운 목록에서 환경을 선택합니다.
    상태 전환하여 알림을 사용 설정 또는 사용 중지합니다.
  4. 알림을 트리거할 조건의 기준과 측정기준을 정의합니다.
    조건 필드 설명
    임계값

    만료되는 인증서의 기간을 구성합니다. 인증서 만료일에 대한 알림을 받도록 선택할 수 있는 기간은 다음과 같습니다.

    • 1일
    • 14일
    • 30일
    측정기준 측정기준은 환경의 모든 TLS 인증서에 해당하는 모든 TLS 인증서 값으로 고정됩니다.
  5. 경고 알림을 추가하려면 +알림을 클릭합니다.
    알림 세부정보 설명
    채널 사용할 알림 채널을 선택하고 대상(Email, Slack, PagerDuty 또는 웹훅)을 지정합니다.
    대상 선택한 채널 유형에 따라 대상 유형을 지정합니다.
    • 이메일 - 이메일 주소(예: joe@company.com)
    • Slack - Slack 채널 URL(예: https://hooks.slack.com/services/T00000000/B00000000/XXXXX)
    • PagerDuty - PagerDuty 코드(예: abcd1234efgh56789)
    • 웹훅 - 웹훅 URL(예: https://apigee.com/test-webhook)

      참고: 알림당 대상을 하나만 지정할 수 있습니다. 동일한 채널 유형에 여러 대상을 지정하려면 알림을 추가하세요.
  6. 알림을 더 추가하려면 이전 단계를 반복합니다.
  7. 알림을 추가한 경우 다음 필드를 설정합니다.
    필드 설명
    플레이북 (선택사항) 알림 실행 시 문제를 해결하기 위한 권장 조치에 대한 간단한 설명을 제공하는 자유 형식 텍스트 입력란입니다. 권장사항을 참조하는 내부 위키 또는 커뮤니티 페이지의 링크를 지정할 수도 있습니다. 이 필드의 정보는 알림에 포함됩니다. 이 필드의 내용은 1,500자를 초과할 수 없습니다.
    제한 알림을 전송할 빈도입니다. 드롭다운 목록에서 값을 선택합니다.
  8. 저장을 클릭합니다.

이벤트 대시보드에서 알림 보기

Edge는 알림 조건을 감지하면 Edge UI의 이벤트 대시보드에 조건을 자동으로 로깅합니다. 이벤트 대시보드에 표시되는 이벤트 목록에는 고정 알림과 인증서의 모든 알림이 포함됩니다.

알림을 보려면 다음 단계를 따르세요.

  1. Edge UI에서 분석 > 이벤트를 클릭합니다. 새로운 이벤트 대시보드가 나타납니다.

  2. 다음을 기준으로 이벤트 대시보드를 필터링합니다.

    • 환경
    • 리전
    • 기간
  3. 이벤트 대시보드에서 행을 선택하여 만료 인증서가 포함된 키 저장소를 표시하여 알림을 자세히 조사하세요. 키 저장소 페이지에서 새 인증서를 업로드하고 만료되는 인증서를 삭제할 수 있습니다.

만료 알림과 함께 알림 API 사용

만료 알림을 만들고 관리하는 데 사용하는 대부분의 API는 고정 알림에서 사용하는 API와 동일합니다. 다음 알림 API는 고정 알림과 만료 알림에서 모두 동일한 방식으로 작동합니다.

하지만 일부 API에는 이상 알림을 지원하는 데 사용되는 다음과 같은 추가 속성이 있습니다.

  • 알림 받기 - 수정된 알림 및 이상치 알림을 포함한 모든 알림을 표시합니다.
  • 알림 만들기 - 수정된 알림 또는 이상치 알림을 만듭니다.
  • 알림 업데이트: 고정 또는 이상 알림 정의를 업데이트합니다.

만료 알림 만들기 또는 업데이트

현재 수정된 알림과 동일한 API를 사용하여 만료 알림을 만들거나 업데이트하세요. 만료 알림을 만들거나 업데이트하는 API 호출의 본문은 고정된 알림의 본문과 동일하지만 다음과 같은 변경사항이 있습니다.

  • 알림이 만료 알림임을 지정하려면 다음과 같은 새 속성을 추가해야 합니다.

    "alertType": "cert"
"alertSubType": "certfixed"

    이러한 속성의 기본값은 다음과 같습니다.

    "alertType": "runtime"
"alertSubType": "fixed"

  • conditions 배열에서:

    • metrics 속성은 expiration 값만 사용합니다.
    • gracePeriodSeconds 속성을 사용하여 인증서 만료 기간을 초 단위로 최대 30일까지 지정합니다.
    • threshold, durationSeconds, comparator 속성은 지원되지 않습니다.
  • conditions 배열의 dimensions 요소에서:
    • certificate 속성의 값을 ANY로 설정해야 합니다.
    • proxy 속성의 값을 ALL로 설정해야 합니다.
    • statusCode, developerApp, collection, faultCodeCategory, faultCodeSubCategory, faultCodeName 속성은 지원되지 않습니다.
  • reportEnabled 속성은 만료 알림을 지원하지 않습니다.

다음 API 호출 예시에서는 프로덕션 환경의 모든 호출 기간이 30일 이내에 만료될 때 트리거되는 만료 알림을 만듭니다. 알림이 트리거되면 지정된 이메일 주소로 알림이 전송됩니다.

curl 'https://apimonitoring.enterprise.apigee.com/alerts' \
 -X POST \
 -H 'Accept: application/json, text/plain, */*' -H "Content-Type: application/json" \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -d '{
  "organization":"myorg",
  "name":"My Cert Expiry Alert",
  "description":"My Cert Expiry Alert",
  "environment":"prod",
  "enabled":true,
  "alertType": "cert",
  "alertSubType": "certfixed",
  "conditions":[
  {
    "description":"My Cert Expiry Alert",
    "dimensions":{
      "org":"myorg",
      "env":"prod",
      "proxy":"ALL",
      "certificate": "ANY"
    },
    "metric":"expiration",
    "gracePeriodSeconds": 2592000
  }],
  "notifications":[{
    "channel":"email",
    "destination":"ops@acme.com"
  }],
  "playbook":"http://acme.com/pb.html",
  "throttleIntervalSeconds":3600,
  "reportEnabled":false
}'

OAuth 2.0 액세스 토큰 가져오기에 설명된 대로 $ACCESS_TOKEN을 OAuth 2.0 액세스 토큰으로 설정합니다. 이 예에서 사용된 cURL 옵션에 대한 자세한 내용은 cURL 사용을 참조하세요.

만료 알림 받기

기본적으로 Get Alerts API는 정의된 모든 알림(수정된 알림과 만료 알림)에 대한 정보를 반환합니다. 이제 이 API에서 쿼리 매개변수를 사용하여 결과를 필터링할 수 있습니다.

  • enabled - true가 사용 설정된 알림만 반환하도록 지정하는 경우입니다. 기본값은 false입니다.
  • alertType - 반환할 알림 유형을 지정합니다. 허용되는 값은 기본값인 runtime 및 cert입니다.
  • alertSubType - 반환할 알림 하위유형을 지정합니다. 기본값이 설정되지 않으면 모든 알림 하위유형이 반환됩니다. 만료 알림을 반환하려면 certfixed를 지정합니다.

예를 들어 다음 API 호출을 사용하여 myorg라는 조직에 대한 알림만 사용 설정합니다.

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
'https://apimonitoring.enterprise.apigee.com/alerts?org=myorg&enabled=true'

다음 호출은 사용 설정된 상태와 사용 중지된 상태의 만료 알림만 반환합니다.

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
'https://apimonitoring.enterprise.apigee.com/alerts?org=myorg&alertType=cert&alertSubType=certfixed'

OAuth 2.0 액세스 토큰 가져오기에 설명된 대로 $ACCESS_TOKEN을 OAuth 2.0 액세스 토큰으로 설정합니다. 이 예에서 사용된 cURL 옵션에 대한 자세한 내용은 cURL 사용을 참조하세요.