メインコンテンツまでスキップ

Request Termination

概要

リクエスト終了ポリシーは、APIへのすべての受信リクエストを即座にブロックし、事前定義されたHTTPレスポンスを返すために使用されます。これは、メンテナンスウィンドウ、サービス停止、または緊急停止中に一般的に適用され、APIがリクエストをバックエンドサービスに転送しないことを保証します。

有効にすると、このポリシーはクライアントにカスタムメッセージとHTTPステータスコードを返し、さらなる処理やバックエンド統合を呼び出すことはありません。

Request Termination

設定の詳細

FieldDescription
リクエスト終了メッセージAPIが強制終了されたときにクライアントに返されるメッセージ。
例: 一時的にサービス利用不可
リクエスト終了HTTPステータスコードレスポンスと共に返されるHTTPステータスコード。一般的な値:
503 (サービス利用不可)、403 (禁止)、404 (見つかりません) など。
注記

変更不可: 有効にすると、このポリシーは削除または無効にすることができません。

設定値を変更できません: 有効にすると、設定値(メッセージとコード)は変更できません。

例の出力

上記の画像のように設定されている場合:

HTTP/1.1 503 Service Unavailable
Content-Type: text/plain
Service Temporarily Unavailable

このレスポンスは、ポリシーがアクティブな間、APIを呼び出すすべてのクライアントに返されます。