このページは Cloud Translation API によって翻訳されました。

Message Processor の keep-alive タイムアウトを構成する

Apigee Edge のドキュメントを表示しています。
Apigee X のドキュメントをご覧ください。

このドキュメントでは、Apigee Edge Message Processor の keep-alive タイムアウトを構成する方法について説明します。

Message Processor のキープアライブタイムアウトを使用すると、1 つの TCP 接続でリクエストとレスポンスのペアごとに新しい接続を開くのではなく、バックエンドサーバーとの間で複数の HTTP リクエスト / レスポンスを送受信できます。

Message Processor の keep-alive タイムアウトプロパティのデフォルト値は 60 秒です。このタイムアウト時間は、ターゲットエンドポイント構成と API プロキシの ServiceCallout ポリシーで構成されたバックエンドサーバーに適用されます。

Message Processor のキープアライブタイムアウトは、必要に応じてデフォルト値の 60 秒から増減できます。次の方法で構成できます。

API プロキシの場合:
- ターゲットエンドポイント
- ServiceCallout ポリシー内
Message Processor の場合

Message Processor のキープアライブタイムアウトは、次のプロパティによって制御されます。

プロパティ名ロケーション説明

プロパティ名	ロケーション	説明
`keepalive.timeout.millis`	API プロキシ: ターゲットエンドポイント `ServiceCallout` ポリシー	これは、Message Processor がリクエスト/レスポンスのペアごとに新しい接続を開くのではなく、1 つの TCP 接続で複数の HTTP リクエスト/レスポンスを送受信できる最大のアイドル時間です。デフォルトでは、このプロパティは Message Processor の `HTTPClient.keepalive.timeout.millis` プロパティに設定された値を使用します。デフォルト値は `60` 秒です。このプロパティがターゲットエンドポイントで使用されているターゲットサーバーの新しいタイムアウト値または特定の API プロキシの `ServiceCallout` ポリシーで変更されている場合、その特定のターゲットサーバーの keep-alive 時間のみが影響を受けます。
`HTTPClient.keepalive.timeout.millis`	Message Processor	これは、Message Processor がリクエスト/レスポンスのペアごとに新しい接続を開くのではなく、1 つの TCP 接続で複数の HTTP リクエスト/レスポンスを送受信できる最大のアイドル時間です。このプロパティは、Message Processor で実行されるすべての API プロキシで使用されます。このプロパティのデフォルト値は `60` 秒です。このプロパティは、後述の Message Processor の keep-alive タイムアウトを構成するの説明に従って変更できます。または、API プロキシレベルで `keepalive.timeout.millis` プロパティを設定することで、この値を上書きできます。

keepalive.timeout.millis

API プロキシ:

ターゲットエンドポイント
ServiceCallout ポリシー

これは、Message Processor がリクエスト/レスポンスのペアごとに新しい接続を開くのではなく、1 つの TCP 接続で複数の HTTP リクエスト/レスポンスを送受信できる最大のアイドル時間です。

デフォルトでは、このプロパティは Message Processor の HTTPClient.keepalive.timeout.millis プロパティに設定された値を使用します。デフォルト値は 60 秒です。

このプロパティがターゲットエンドポイントで使用されているターゲットサーバーの新しいタイムアウト値または特定の API プロキシの ServiceCallout ポリシーで変更されている場合、その特定のターゲットサーバーの keep-alive 時間のみが影響を受けます。

HTTPClient.keepalive.timeout.millis

Message Processor

このプロパティは、Message Processor で実行されるすべての API プロキシで使用されます。

このプロパティのデフォルト値は 60 秒です。

このプロパティは、後述の Message Processor の keep-alive タイムアウトを構成するの説明に従って変更できます。または、API プロキシレベルで keepalive.timeout.millis プロパティを設定することで、この値を上書きできます。

始める前に

このドキュメントの手順を使用する前に、次のトピックを理解しておいてください。

キープアライブタイムアウトの詳細については、 TargetEndpoint トランスポートプロパティ仕様の keepalive.timeout.millis プロパティの説明をご覧ください。
Edge for Private Cloud のプロパティ構成が不明な場合は、 Edge の構成方法をご覧ください。

API プロキシでのキープアライブタイムアウトの構成

キープアライブのタイムアウトは、API プロキシの次の場所で構成できます。

ターゲットエンドポイント
ServiceCallout ポリシー

API プロキシのターゲットエンドポイントでのキープアライブタイムアウトの構成

このセクションでは、API プロキシのターゲットエンドポイントで keep-alive タイムアウトを構成する方法について説明します。キープアライブのタイムアウトは、プロパティ keepalive.timeout.millis を使って構成できます。これは、キープアライブのタイムアウト値をミリ秒単位で表します。

注: API プロキシのターゲットエンドポイントでキープアライブタイムアウトを構成すると、デフォルト値（60 秒）が新しい値でオーバーライドされ、構成されている特定の API プロキシにのみ影響します。残りの API プロキシでは、引き続きデフォルトの keep-alive タイムアウト値 60 秒が使用されます。

Edge UI で、新しいキープアライブタイムアウト値を構成する特定の API プロキシを選択します。
変更するターゲットエンドポイントを選択します。
TargetEndpoint 構成の <HTTPTargetConnection> 要素の下に、適切な値を指定してプロパティ keepalive.timeout.millis を追加します。

たとえば、キープアライブのタイムアウトを 30 秒に変更するには、次のコードブロックを追加します。
```
<Properties>
  <Property name="keepalive.timeout.millis">30000</Property>
</Properties>
```
keepalive.timeout.millis プロパティはミリ秒単位であるため、30 秒の値は 30000 になります。

次の例は、API プロキシのターゲットエンドポイント構成でキープアライブタイムアウトを構成する方法を示しています。

バックエンドサーバーの URL を使用したターゲットエンドポイント構成の例
```
<TargetEndpoint name="default">
  <HTTPTargetConnection>
    <URL>https://mocktarget.apigee.net/json</URL>
    <Properties>
      <Property name="keepalive.timeout.millis">30000</Property>
    </Properties>
  </HTTPTargetConnection>
</TargetEndpoint>
```
ターゲットサーバーを使用したターゲットエンドポイント構成の例
```
<TargetEndpoint name="default">
  <HTTPTargetConnection>
    <LoadBalancer>
      <Server name="target1" />
      <Server name="target2" />
    </LoadBalancer>
    <Properties>
      <Property name="keepalive.timeout.millis">30000</Property>
    </Properties>
    <Path>/test</Path>
  </HTTPTargetConnection>
</TargetEndpoint>
```
注: プロパティ値にはリテラルのみを使用できます。変数を使用して値を設定することはできません。
API プロキシに加えた変更を保存します。

API プロキシの Service コールアウトポリシーで keep-alive タイムアウトを構成する

このセクションでは、API プロキシの ServiceCallout ポリシーでキープアライブタイムアウトを構成する方法について説明します。キープアライブのタイムアウトは、キープアライブのタイムアウト値をミリ秒単位で表した the keepalive.timeout.millis プロパティを使用して構成できます。

注: API プロキシの ServiceCallout ポリシーでキープアライブタイムアウトを構成すると、デフォルト値（60 秒）が新しい値でオーバーライドされ、構成されている特定の ServiceCallout ポリシーにのみ適用されます。残りの ServiceCallout ポリシーと API プロキシでは、引き続きデフォルトの有効期間（60 秒）が使用されます。

必要な権限: このタスクを行うには、ServiceCallout ポリシーのキープアライブタイムアウトを構成する特定の API プロキシに対する編集権限が必要です。

keepalive.timeout.millis ポリシーを使用して、ServiceCallout ポリシーでキープアライブタイムアウトを構成するには:

Edge UI で、ServiceCallout ポリシーの新しい keep-alive タイムアウト値を構成する特定の API プロキシを選択します。
変更する ServiceCallout ポリシーを選択します。
TargetEndpoint 構成の <HTTPTargetConnection> 要素の下に、プロパティ keepalive.timeout.millis を適切な値で追加します。
たとえば、キープアライブのタイムアウトを 30 秒に変更するには、次のコードブロックを追加します。
```
<Properties>
  <Property name="keepalive.timeout.millis">30000</Property>
</Properties>
```
keepalive.timeout.millis プロパティはミリ秒単位であるため、30 秒の値は 30000 になります。

次の例は、API プロキシの ServiceCallout ポリシーでキープアライブタイムアウトを構成する方法を示しています。

バックエンドサーバーの URL を使用した Service コールアウトポリシーの構成例
```
<ServiceCallout name="Service-Callout-1">
  <DisplayName>Service Callout-1</DisplayName>
  <HTTPTargetConnection>
    <Properties>
      <Property name="keepalive.timeout.millis">30000</Property>
    </Properties>
    <URL>https://mocktarget.apigee.net/json</URL>
  </HTTPTargetConnection>
</ServiceCallout>
```
ターゲットサーバーを使用した Service コールアウトポリシーの構成例
```
<ServiceCallout enabled="true" name="Service-Callout-1">
  <DisplayName>Service Callout-1</DisplayName>
  <Response>calloutResponse</Response>
  <HTTPTargetConnection>
    <LoadBalancer>
      <Server name="target1" />
      <Server name="target2" />
    </LoadBalancer>
    <Properties>
      <Property name="keepalive.timeout.millis">30000</Property>
    </Properties>
    <Path>/test</Path>
  </HTTPTargetConnection>
</ServiceCallout>
```
注: プロパティ値にはリテラルのみを使用できます。変数を使用して値を設定することはできません。
API プロキシに加えた変更を保存します。