Thiết lập cảnh báo hết hạn

Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến Tài liệu về Apigee X. thông tin

Sử dụng thông báo hết hạn TLS để gửi thông báo khi chứng chỉ TLS trong một môi trường sắp hết hạn.

Giới thiệu về chứng chỉ TLS

TLS (Bảo mật tầng truyền tải) là công nghệ bảo mật tiêu chuẩn để thiết lập liên kết được mã hoá giữa máy chủ web và ứng dụng web, chẳng hạn như trình duyệt hoặc . Đường liên kết được mã hoá giúp đảm bảo rằng tất cả dữ liệu truyền giữa máy chủ và máy khách vẫn được giữ nguyên riêng tư.

Chứng chỉ TLS là một tệp kỹ thuật số giúp nhận dạng một thực thể trong giao dịch TLS. Edge sử dụng một TLS (Bảo mật tầng truyền tải) chứng chỉ để định cấu hình TLS cho:

Chứng chỉ TLS chứa ngày hết hạn. Nếu một chứng chỉ TLS hết hạn, thì kết nối TLS sẽ không thành công cho đến khi bạn cập nhật chứng chỉ. Tức là mọi yêu cầu đối với API của bạn sẽ không thực hiện được cho đến khi bạn cập nhật chứng chỉ.

Giới thiệu về cảnh báo hết hạn

Thay vì đợi một chứng chỉ hết hạn và để các yêu cầu đến API của bạn không thành công, hãy sử dụng cảnh báo hết hạn để tăng thông báo khi bất kỳ chứng chỉ TLS nào trong một môi trường sắp hết hạn. Sau khi cảnh báo được kích hoạt, bạn có thể cập nhật chứng chỉ để khách hàng của mình sẽ không thấy bất kỳ sự gián đoạn dịch vụ nào.

Khi định cấu hình cảnh báo, không chỉ định một chứng chỉ riêng lẻ mà chỉ định một môi trường cụ thể. Cảnh báo được kích hoạt khi bất kỳ chứng chỉ nào được triển khai được lên lịch hết hạn trong khoảng thời gian được chỉ định.

Bạn có thể thiết lập để cảnh báo hết hạn xuất hiện:

  • 1 ngày trước khi chứng chỉ hết hạn
  • 14 ngày trước khi bất kỳ chứng chỉ nào hết hạn
  • 30 ngày trước khi bất kỳ chứng chỉ nào hết hạn
Để biết thêm thông tin về cảnh báo, hãy xem bài viết Thiết lập cảnh báo và thông báo.

Thêm thông báo và cảnh báo hết hạn

Cách thêm thông báo và cảnh báo hết hạn:
  1. Nhấp vào Analyze (Phân tích) > Quy tắc cảnh báo trong giao diện người dùng Edge.
  2. Nhấp vào +Cảnh báo.
  3. Nhập thông tin chung sau đây về cảnh báo:
    Trường Mô tả
    Tên cảnh báo Tên của cảnh báo. Sử dụng tên mô tả điều kiện kích hoạt và có ý nghĩa đối với bạn. Tên không được vượt quá 128 ký tự.
    Mô tả Nội dung mô tả về cảnh báo.
    Loại Cảnh báo Chọn TLS hết hạn. Xem Giới thiệu về các loại thông báo để tìm hiểu thêm.
    Môi trường Chọn môi trường từ danh sách thả xuống.
    Trạng thái Nhấp vào nút bật/tắt để bật hoặc tắt cảnh báo.
  4. Xác định ngưỡng và phương diện cho điều kiện sẽ kích hoạt cảnh báo.
    Trường điều kiện Mô tả
    Ngưỡng

    Định cấu hình phạm vi thời gian cho các chứng chỉ sắp hết hạn. Bạn có thể chọn cảnh báo khi một chứng chỉ sắp hết hạn trong:

    • 1 ngày
    • 14 ngày
    • 30 ngày
    Phương diện Các phương diện này được cố định thành giá trị là Any TLS Certificate (Mọi chứng chỉ TLS) tương ứng với bất kỳ chứng chỉ TLS nào trong môi trường.
  5. Nhấp vào + Thông báo để thêm thông báo cảnh báo.
    Chi tiết thông báo Mô tả
    Kênh Chọn kênh thông báo mà bạn muốn dùng rồi chỉ định đích đến: Email, Slack, PagerDuty hoặc Webhook.
    Đích đến Chỉ định đích đến dựa trên loại kênh đã chọn:
    • Email – Địa chỉ email, chẳng hạn như joe@company.com
    • Slack – URL kênh Slack, chẳng hạn như https://hooks.slack.com/services/T00000000/B00000000/XXXXX
    • PagerDuty – Mã PagerDuty, chẳng hạn như abcd1234efgh56789
    • Webhook – URL webhook, chẳng hạn như https://apigee.com/test-webhook

      Lưu ý: Bạn chỉ có thể chỉ định một đích đến cho mỗi thông báo. Để chỉ định nhiều đích đến đối với cùng một loại kênh, hãy thêm thông báo bổ sung.
  6. Để thêm các thông báo khác, hãy lặp lại bước trước đó.
  7. Nếu bạn đã thêm một thông báo, hãy thiết lập các trường sau:
    Trường Mô tả
    Cẩm nang (Không bắt buộc) Trường văn bản dạng tự do để cung cấp nội dung mô tả ngắn về các hành động được đề xuất để giải quyết các cảnh báo khi chúng kích hoạt. Bạn cũng có thể chỉ định một liên kết tới wiki nội bộ hoặc trang cộng đồng của mình nơi bạn tham khảo các phương pháp hay nhất. Thông tin trong trường này sẽ được đưa vào thông báo. Nội dung trong trường này không được vượt quá 1500 ký tự.
    Van tiết lưu Tần suất gửi thông báo. Chọn một giá trị trong danh sách thả xuống.
  8. Nhấp vào Lưu.

Xem thông báo trong trang tổng quan Sự kiện

Khi phát hiện một điều kiện cảnh báo, Edge sẽ tự động ghi lại điều kiện đó vào Trang tổng quan Sự kiện trong giao diện người dùng Edge. Danh sách sự kiện xuất hiện trên trang tổng quan Sự kiện bao gồm tất cả cảnh báo, cả cảnh báo đã được khắc phục và cảnh báo cấp chứng chỉ.

Cách xem cảnh báo:

  1. Nhấp vào Analyze (Phân tích) > Sự kiện trong giao diện người dùng Edge. Trang tổng quan Sự kiện mới sẽ xuất hiện:

  2. Lọc trang tổng quan Sự kiện theo:

    • Môi trường
    • Khu vực
    • Khoảng thời gian
  3. Chọn một hàng trong Trang tổng quan sự kiện để hiển thị Kho khoá có chứa chứng chỉ sắp hết hạn cho điều tra thêm về cảnh báo. Từ trang Kho khoá, bạn có thể tải một chứng chỉ mới lên và xoá chứng chỉ hết hạn.

Sử dụng API cảnh báo có cảnh báo hết hạn

Hầu hết API mà bạn dùng để tạo và quản lý cảnh báo hết hạn đều giống như các API mà bạn sử dụng với các cảnh báo đã được khắc phục. Các API cảnh báo sau đây hoạt động theo cách tương tự cho cả cảnh báo cố định và cảnh báo hết hạn:

Tuy nhiên, một số API có các thuộc tính bổ sung được dùng để hỗ trợ cảnh báo bất thường, bao gồm:

  • Nhận cảnh báo – Liệt kê tất cả cảnh báo, bao gồm cả cảnh báo đã khắc phục và cảnh báo bất thường.
  • Tạo cảnh báo – Tạo cảnh báo cố định hoặc cảnh báo bất thường.
  • Cập nhật cảnh báo – Cập nhật định nghĩa về cảnh báo cố định hoặc bất thường.

Tạo hoặc cập nhật thông báo hết hạn

Sử dụng cùng API để tạo hoặc cập nhật cảnh báo hết hạn như bạn hiện đang làm với một cảnh báo cố định. Nội dung của lệnh gọi API để tạo hoặc cập nhật cảnh báo hết hạn cũng giống như được sử dụng cho một cảnh báo cố định, với những thay đổi sau:

  • Bạn phải thêm các thuộc tính mới sau đây để chỉ định rằng cảnh báo này là một cảnh báo hết hạn:

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

    Giá trị mặc định của các thuộc tính này là:

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

  • Trong mảng conditions:

    • Thuộc tính metrics chỉ nhận các giá trị của expiration.
    • Sử dụng thuộc tính gracePeriodSeconds để chỉ định khoảng thời gian hết hạn chứng chỉ tính bằng giây, tối đa là 30 ngày.
    • Các thuộc tính threshold, durationSeconds và comparator không được hỗ trợ.
  • Trong phần tử dimensions của mảng conditions:
    • Bạn phải đặt giá trị của thuộc tính certificate thành ANY.
    • Bạn phải đặt giá trị của thuộc tính proxy thành ALL.
    • statusCode, developerApp, collection, faultCodeCategory, Các thuộc tính faultCodeSubCategory, faultCodeName không được hỗ trợ.
  • Không hỗ trợ thuộc tính reportEnabled cho cảnh báo hết hạn.

Lệnh gọi API mẫu sau đây sẽ tạo một cảnh báo hết hạn được kích hoạt khi có bất kỳ tiếng kêu gọi nào trong môi trường sản phẩm sẽ hết hạn trong 30 ngày tới. Thông báo được gửi đến địa chỉ email đã chỉ định khi cảnh báo được kích hoạt:

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

Đặt $ACCESS_TOKEN thành mã truy cập OAuth 2.0 của bạn, như mô tả trong Nhận mã truy cập OAuth 2.0. Để biết thông tin về các tuỳ chọn cURL được sử dụng trong ví dụ này, hãy xem phần Sử dụng cURL.

Nhận thông báo về ngày hết hạn

Theo mặc định, API Get Alerts (Nhận cảnh báo) trả về thông tin về tất cả cảnh báo đã xác định, cả cảnh báo cố định và cảnh báo hết hạn. API này hiện sử dụng các tham số truy vấn để giúp bạn lọc kết quả:

  • enabled – Nếu true chỉ định chỉ trả về cảnh báo đã bật. Giá trị mặc định là false.
  • alertType – Chỉ định loại cảnh báo cần trả về. Giá trị được phép là runtime, giá trị mặc định và cert.
  • alertSubType – Chỉ định loại cảnh báo phụ cần trả về. Giá trị mặc định là chưa được đặt, tức là trả về mọi loại cảnh báo phụ. Chỉ định certfixed để trả về cảnh báo hết hạn.

Ví dụ: sử dụng lệnh gọi API sau đây để chỉ trả về các thông báo cho phép đối với tổ chức có tên là myorg:

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

Lệnh gọi sau đây chỉ trả về cảnh báo hết hạn, cả đã bật và đã tắt:

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

Đặt $ACCESS_TOKEN thành mã truy cập OAuth 2.0 của bạn, như mô tả trong Nhận mã truy cập OAuth 2.0. Để biết thông tin về các tuỳ chọn cURL được sử dụng trong ví dụ này, hãy xem phần Sử dụng cURL.