応答を返す

return-response ポリシーでは、パイプラインの実行を取り消し、既定またはカスタムの応答を呼び出し元に返します。 既定の応答は、本文のない 200 OK です。 コンテキスト変数またはポリシー ステートメントを使用して、カスタムの応答を指定できます。 その両方を指定した場合、コンテキスト変数に含まれる応答が、呼び出し元に返される前にポリシー ステートメントによって変更されます。

Note

ポリシーの要素と子要素を、ポリシー ステートメントで指定された順序で設定します。 API Management ポリシーを設定または編集する方法について説明します。

ポリシー ステートメント

<return-response response-variable-name="existing context variable">
  <set-status>...</set-status>
  <set-header>...</set-header>
  <set-body>...</set-body>
</return-response>

属性

属性	説明	必須	Default
response-variable-name	たとえば、アップストリームの send-request ポリシーから参照され、Response オブジェクトを含むコンテキスト変数の名前。	いいえ	該当なし

要素

要素	説明	必須
set-status	set-status ポリシー ステートメント。	No
set-header	set-header ポリシー ステートメント。	No
set-body	set-body ポリシー ステートメント。	いいえ

使用法

• ポリシー セクション: inbound、outbound、backend、on-error
• ポリシー スコープ: グローバル、製品、API、操作
• ゲートウェイ: 専用、従量課金、セルフホステッド

例

<return-response>
   <set-status code="401" reason="Unauthorized"/>
   <set-header name="WWW-Authenticate" exists-action="override">
      <value>Bearer error="invalid_token"</value>
   </set-header>
</return-response>

関連ポリシー

• API Management の高度なポリシー

次のステップ

ポリシーに対する処理の詳細については、次のトピックを参照してください。

• チュートリアル:API を変換および保護する
• ポリシー ステートメントとその設定の一覧に関するポリシー リファレンス
• ポリシー式
• ポリシーの設定または編集
• ポリシー構成を再利用する
• ポリシーのサンプル