Send Docs Feedback

Note: Most user interface tasks can be performed in Edge Classic or the New Edge experience. For an overview, getting started topics, and release notes specific to the New Edge experience, see the docs.

Attaching and configuring policies in the management UI

ポリシーベースの機能を API プロキシに追加する場合、次の 2 つの手順を実行します。

  1. ポリシータイプのインスタンスを構成します。
  2. ポリシーインスタンスをフローに添付します。

以下の図では、ポリシーとフローの関係を示します。すでにお気付きでしょうが、ポリシーは処理「ステップ」としてフローに添付されます。API のために目的の動作を構成するには、フローに関する理解を少し深める必要があります。このトピックについては、前述の「フローの構成」で触れています。

一般的に使用されているポリシータイプの 1 つに SpikeArrest があります。SpikeArrest は、バックエンドサービスのパフォーマンス低下の原因になるメッセージトラフィックの急増を防止します。

Attaching a policy to a flow

ポリシーをフローに添付するには :

  1. Select an API proxy and navigate to the Develop view.
  2. In the API Proxy Editor, select the flow to which you want to attach a policy in the Navigator pane.
    For example, the PreFlow flow is selected for the default API proxy endpoint in the following figure:
  3. In the Design view, click +Step associated with the request or response flow to attach a policy. For example:

    The Add Step dialog opens displaying a categorized list of policies.
  4. Scroll and select the policy type that you want to attach to the selected flow.
  5. Modify the following fields.
    • Display Name: Unique display name for the policy. The UI will generate a default name, but it is advisable to create a descriptive name for the policy. This will ensure that other developers in your organization have an easy time understanding what the policy is intended to do. 

    • Name: Unique name for the policy. The policy name matches the display name with the following exceptions:

      • Spaces are replaced by dashes.

      • Consecutive dashes are replaced by a single dash.

      • Except for dashes, underscores, and spaces (which are replaced, as noted above), characters that are not alphanumeric, such as pound signs, percent signs, ampersands, and so on, are removed.

  6. Click Add.

    The policy is attached to the selected flow.

After the policy is attached, you’ll see the policy displayed in the Designer view for the flow, in this example the PreFlow of the default proxy endpoint, and in the Policies list in the Navigation pane. The Code view, which displays the XML for the newly attached policy, displays below the Designer view. Edge generates an instance of the policy that contains a set of reasonable default values.

Adding a policy without attaching it to a flow

To add a policy without attaching it to a flow, which is useful for Handling faults, click + in the Policies bar in the Navigator view to open the Add Policy dialog and add the policy (as described in steps 4 through 6 in the previous section). 

A policy that is not attached to any flow is flagged with the "detached" icon in the Policies list, as shown adjacent to the API key message policy shown in the previous figure.

After you create the policy, you can attach it to a flow by dragging and dropping it from the Policies list to the desired flow in the Designer view.

Detaching policies from a flow

To detach a policy from a Flow, select the Flow. Mouse over the icon for the policy in the Designer view of the Flow. Click the X in the circle that appears in the icon. 

Deleting a policy instance

To delete a policy instance, mouse over the entry for the policy in the Navigator view. Click the X in the circle that appears to the right of the entry.

管理 UI でのポリシーの構成

この UI でポリシーインスタンスを生成するとき、一般的な設定に適切なデフォルト値が適用されます。要件に応じてこれらの設定を変更しなければならない場合があります。

例:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<SpikeArrest async="false" continueOnError="false" enabled="true" name="spikearrest-1">
  <DisplayName>SpikeArrest-1</DisplayName>
  <FaultRules/>
  <Properties/>
  <Identifier ref="request.header.some-header-name"/>
  <MessageWeight ref="request.header.weight"/>
  <Rate>30ps</Rate>
</SpikeArrest>

「Code」ビューで XML 構成を直接編集することで、ポリシーを構成できます。例えば、Spike Arrest ポリシーのピークメッセージレートは当初 1 秒あたり 30 メッセージに設定されています。このピークレートの変更は、ポリシーの XML で <Rate> 要素値を変更することで実行できます。ポリシー構成の詳細については、「Policy Reference」を参照してください。

また「Code」ビューでは、ポリシーの切り取りと貼り付けを実行できます。GitHub にある使用可能なサンプルからポリシーを再利用する場合、これは便利な方法です。

「Code」ビューでポリシー定義を変更すると、この変更は Property Inspector に反映されます。またこの逆も同様です。Property Inspector で変更を行うと、「Code」ビューの XML に変更が反映されます。

このトピックで使用される Quota ポリシーのドキュメントについては、「Quota policy」を参照してください。

Help or comments?