有効期限があるアラートの設定

<ph type="x-smartling-placeholder"></ph> 現在、Apigee Edge のドキュメントが表示されています。
Apigee X のドキュメント。 詳細

TLS の有効期限アラートを使用して 環境内の TLS 証明書の有効期限が近づいたときに通知されるようにする。

TLS 証明書について

TLS（Transport Layer Security）は標準的なセキュリティ テクノロジー を使用して、ウェブサーバーとウェブ クライアント（ブラウザや 。暗号化されたリンクにより、サーバーとクライアントの間で送受信されるすべてのデータが保持される 非公開です。

TLS 証明書は、TLS トランザクションでエンティティを識別するデジタル ファイルです。Edge は TLS を TLS を構成するための証明書:

TLS 証明書には有効期限が含まれています。TLS 証明書の有効期限が切れると、TLS 接続は失敗します 証明書を更新するまで継続されます。つまり、証明書を更新するまで、API に対するすべてのリクエストは失敗します。

有効期限のアラートについて

証明書の期限切れを待たずに API へのリクエストが失敗するのを待つのではなく、 アラートを生成し、 環境内の TLS 証明書の有効期限が近づいたときに通知されるようにする。 アラートがトリガーされた後、証明書を更新して、 中断されることはありません。

アラートを構成するときは、個々の証明書ではなく、特定の環境を指定します。 デプロイされた証明書がスケジュールされると、アラートがトリガーされる 期限切れになります。

有効期限のアラートは、次のように設定できます。

  • 認定資格が期限切れになる 1 日前
  • 認定資格が期限切れになる 14 日前
  • 認定資格が期限切れになる 30 日前
で確認できます。 アラートの詳細については、アラートと通知を設定するをご覧ください。

期限切れのアラートと通知を追加する

期限切れのアラートと通知を追加するには: <ph type="x-smartling-placeholder">
    </ph>
  1. Edge UI で [Analyze] > [Alert Rules] をクリックします。
  2. [+Alert] をクリックします。
  3. アラートに関する次の一般情報を入力します。
    項目 説明
    アラート名 アラートの名前。トリガーを表すわかりやすい名前を付けます。 名前は 128 文字以内で指定してください。
    説明 アラートの説明。
    アラートの種類 [TLS の有効期限] を選択します。詳しくは、 詳細については、アラートの種類についてをご覧ください。
    環境 プルダウン リストから環境を選択します。
    ステータス アラートを有効または無効に切り替えます。
  4. アラートをトリガーする条件のしきい値とディメンションを定義します。
    条件フィールド 説明
    しきい値

    有効期限が近い証明書の期間を構成します。認定資格の有効期限が近づいたときにアラートを生成するように選択できます。

    • 1 日
    • 14 日
    • 30 日
    ディメンション ディメンションは、対応する [Any TLS Certificates] の値に固定されています。 証明書を記録します。
  5. [+ Notification] をクリックして、アラート通知を追加します。
    通知の詳細 説明
    チャネル 使用する通知チャネルを選択し、送信先を指定します（メール、Slack、PagerDuty、または Webhook）。
    発信先 選択したチャネルタイプに基づいて宛先を指定します。 <ph type="x-smartling-placeholder">
      </ph>
    • メール - メールアドレス（joe@company.com など）
    • Slack - Slack チャンネル URL（https://hooks.slack.com/services/T00000000/B00000000/XXXXX など）
    • PagerDuty - PagerDuty コード（abcd1234efgh56789 など）
    • Webhook - Webhook URL（https://apigee.com/test-webhook など）

      注: 通知ごとに 1 つの送信先のみ指定できます。複数の宛先を指定するには 通知を追加します。
  6. さらに通知を追加するには、前の手順を繰り返します。
  7. 通知を追加した場合は、以下の項目を設定します。
    項目 説明
    ハンドブック （省略可）推奨される解決方法の簡単な説明を入力する自由形式のテキスト フィールド アラートを発生させることができます。社内の Wiki やコミュニティ ページへのリンクを指定することもできます。 ベストプラクティスを参照することもできますこのフィールドの情報は通知に含まれます。 このフィールドの内容は 1,500 文字以内で指定してください。
    Throttle 通知を送信する頻度。プルダウンから値を選択します。
  8. [保存] をクリックします。

[Events] ダッシュボードでアラートを表示する

Edge はアラート条件を検出すると、その条件を自動的に [Events] ダッシュボード。[Events] ダッシュボードに表示されるイベントのリスト 固定アラートと認定アラートの両方を含む

アラートを表示するには:

  1. Edge UI で [分析] > [イベント] をクリックします。新しいイベント ダッシュボードが表示されます。

  2. [Events] ダッシュボードは次の項目でフィルタできます。

    • 環境
    • 地域
    • 期間
  3. イベント ダッシュボードで行を選択して、有効期限が近い証明書を含むキーストアを表示し、 詳しく調査する必要があります[Keystore] ページで新しい証明書をアップロードしたり、既存の証明書を 証明書も作成できます。

期限切れのアラートとともにアラート 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 要素で、次のようにします。 <ph type="x-smartling-placeholder">
      </ph>
    • 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
}'

次の説明に沿って、$ACCESS_TOKEN を OAuth 2.0 アクセス トークンに設定します。 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'

次の説明に沿って、$ACCESS_TOKEN を OAuth 2.0 アクセス トークンに設定します。 OAuth 2.0 アクセス トークンを取得します。 この例で使用されている cURL オプションの詳細については、cURL を使用するをご覧ください。