フロー変数リファレンス

クライアント アプリから提示された TLS / SSL 証明書に示されている共通名。

クライアント アプリから提示された TLS / SSL 証明書に示されている国。

クライアント アプリから提示された TLS / SSL 証明書に示されているメールアドレス。

ProxyEndpoint で受信したリクエストに関連付けられている HTTP ホスト IP。

Edge Router にメッセージを送信しているクライアントまたはシステムの IP アドレス。たとえば、元のクライアントの IP であることも、ロードバランサの IP であることもあります。

クライアントから提示された TLS / SSL 証明書に示されている地域（市区町村）。

クライアントから提示された TLS / SSL 証明書に示されている組織単位。

ProxyEndpoint に送信されたクライアント リクエストに関連付けられている HTTP ポート。

プロキシが ProxyEndpoint で発信元クライアントからのリクエストの受信を完了した時刻。文字列形式で表記されます。例: Wed, 21 Aug 2013 19:16:47 UTC。

この時間値は、対応する 32 ビット タイムスタンプの数値の文字列表現です。たとえば「Wed, 21 Aug 2013 19:16:47 UTC」は、タイムスタンプ値 1377112607413 に相当します。

プロキシが ProxyEndpoint で発信元クライアントからのリクエストの受信を完了した時刻を示すタイムスタンプ値。この値は、1970 年 1 月 1 日午前 0 時（UTC）からの経過時間（ミリ秒）を含んだ 64 ビット（long 型）の整数です。

プロキシが ProxyEndpoint で発信元クライアントからのリクエスト受信を開始した時刻。文字列形式で表記されます。例: Wed, 21 Aug 2013 19:16:47 UTC。

この時間値は、対応する 32 ビット タイムスタンプの数値の文字列表現です。たとえば「Wed, 21 Aug 2013 19:16:47 UTC」は、タイムスタンプ値 1377112607413 に相当します。

プロキシが ProxyEndpoint で発信元クライアントからのリクエスト受信を開始した時刻を示すタイムスタンプ値。この値は、1970 年 1 月 1 日午前 0 時（UTC）からの経過時間（ミリ秒）を含んだ 64 ビット（long 型）の整数です。

クライアント アプリがリクエスト メッセージを送信するために使用した転送プロトコルに応じて、http または https を返します。

プロキシが ProxyEndpoint からクライアントへのレスポンス送信を完了した時刻。文字列形式で表記されます。例: "Wed, 21 Aug 2013 19:16:47 UTC"。

この値は、対応する 32 ビット client.sent.end.timestamp の文字列表現です。たとえば、"Wed, 21 Aug 2013 19:16:47 UTC" はタイムスタンプ値 1377112607413 に相当します。

この値は、対応する 32 ビット client.sent.start.timestamp の文字列表現です。たとえば、"Wed, 21 Aug 2013 19:16:47 UTC" はタイムスタンプ値 1377112607413 に相当します。

ProxyEndpoint が TLS / SSL 用に構成されている場合は "true"。そうでない場合は "false"。

クライアントから提示された TLS / SSL 証明書に示されている状態。

エラーに関連付けられているメッセージ。このプロパティの値は、エラーフローの実行前にのみ使用できます。

エラーに関連付けられている HTTP ステータス コード。例: "400"。

エラーに関連付けられている理由句。例: "Bad Request"。

TransportMessage タイプのエラー。

エラーが発生したフロー内での状態。

レスポンス ヘッダーを取得または設定します。

エラーフラグ。

TargetEndpoint での負荷分散中にエラーが発生した TargetServer のリスト。

TargetEndpoint での負荷分散中に呼び出された TargetServer に対してフォールバックが有効にされている場合は "true"。

TargetEndpoint での負荷分散中に呼び出された TargetServer。ロードバランサ要素を定義するときに <Path> 要素が設定されている場合にのみ設定します。

リクエスト フローでは request と同じ値、レスポンス フローでは response と同じ値、エラーフローでは error と同じ値を持つコンテキスト依存オブジェクト。

リクエスト、レスポンス、またはエラー メッセージの内容。

指定されたフォーム パラメータの値。

メッセージに含まれる、指定されたフォーム パラメータのすべての値。

メッセージに含まれる、指定されたフォーム パラメータの値の数。

メッセージに含まれるすべてのフォーム パラメータの合計数。

メッセージに含まれるすべてのフォーム パラメータの値。

メッセージに含まれるフォーム文字列の値。

メッセージに含まれる、指定された HTTP ヘッダーの値を取得または設定します。ヘッダーにカンマが含まれている場合は、読み取り時に、最初のカンマまでのテキスト セグメントのみが返されます。ヘッダー全体が必要な場合は、request.header.header_name.
 values の形式を使用します。

フローの状態により、リクエストまたはレスポンスのメッセージに含まれる特定のヘッダーの N 番目の値。Apigee Edge は、ヘッダーのテキスト値をカンマで区切ります。値が N に使用されるインデックスの最初の値は 0 ではなく 1 です。

たとえば、Cache-control ヘッダーが "public,maxage=16544" の場合、message.header.cache-control.1 は "maxage=16544" を返します。

メッセージに含まれる、指定された HTTP ヘッダー名のすべての値。

メッセージに含まれる、指定された HTTP ヘッダー名の値の数。

メッセージに含まれるすべての HTTP ヘッダーの合計数。

メッセージに含まれるすべての HTTP ヘッダーの値。

クエリ パラメータを除く、URL の完全なリクエスト メッセージパス。

指定されたメッセージ クエリ パラメータを返します。

メッセージ内の N 番目のクエリ パラメータの値。たとえば、request.querystring が "a=hello&a=world" の場合、message.queryparam.a.1 は "hello" を返します。

一例として、"type=siteid:1&type=language:us-en&type=currency:USD" のように単一のクエリ パラメータ名に複数の値を書き込むには、次のように設定します。

• message.queryparam.type.1 を "siteid:1" に設定
• message.queryparam.type.2 を "language:en-us" に設定
• message.queryparam.type.3 を "currency:USD" に設定

メッセージに含まれる特定のクエリ パラメータのすべての値。カンマ区切りのリストとしてフォーマット化されます。

たとえば、クエリ文字列が a=hello&a=world の場合、message.queryparam.a.values の値は "['hello', 'world']" になります。

クライアント アプリから ProxyEndpoint に送信されたリクエストに関連付けられている、指定されたクエリ パラメータの合計数。

クライアント アプリから ProxyEndpoint に送信されたリクエストに関連付けられているすべてのクエリ パラメータの合計数。

クライアント アプリから ProxyEndpoint に送信されたリクエストに関連付けられているすべてのクエリ パラメータ名のリスト。

JavaScript を使用してクエリ パラメータ名を反復処理するには、次の Apigee コミュニティの投稿 How do you iterate Collection from "request.queryparams.names" in JS?（Apigee コミュニティ内）をご覧ください。

クライアント アプリから ProxyEndpoint に送信されたリクエストに関連付けられているすべてのクエリ パラメータの名前と値が含まれる文字列。

たとえば、リクエスト "http://api.apifactory.com/inventors?name=nick&surname=danger" の場合、message.querystring の値は "name=nick&surname=danger" になります。

ターゲットから返されたレスポンス メッセージの理由句。

ターゲットから返されたレスポンス メッセージの HTTP ステータス コード。

コンテキスト依存オブジェクトである TransportMessage タイプのメッセージ。

クエリ パラメータを含む、（ドメイン URL の後に続く）完全な URI パス。

たとえば、リクエスト "http://api.apifactory.com/inventors?name=nikola&surname=tesla" の場合、この変数は "inventors?name=nikola&surname=tesla" を返します。

リクエストに関連付けられた HTTP 動詞（GET、PUT、POST、DELETE など）。

クライアント アプリケーションから ProxyEndpoint に送信されたリクエストに関連付けられている HTTP バージョン。

Router ホスト名が含まれた、リクエストのグローバルに一意な ID を保存します。Router で受信したリクエストを Message Processor に送信した後、この ID を使用して、そのリクエストをトラッキングできます。

この ID は、messageid とエラーを関連付けるために Edge エラーログに記録されます。

組織の名前。

API プロキシ構成に含まれる API プロキシのベースパス。ベースパスは、URL 内でホストの後に続く URI フラグメントです。条件付きフロー URI は、ベースパスの後に続きます。

URL "http://myorg-test.apigee.net/v2/weatherapi/forecastrss?w=12797282" の場合:

• ホストは "myorg-test.apigee.net" です（ホスト名には組織名と環境が含まれます）。
• ベースパスは "/v2/weatherapi" です。

ベースパスを把握するには、API プロキシ定義を調べるか、proxy.basepath の値を確認するしか方法はありません。ベースパスの後には、プロキシパス接尾辞（"/forecastrss"）と任意のクエリ パラメータが続きます。

API プロキシ構成で動的ベースパス（例: /v2/*/weatherapi）を定義すると、ベースパスが静的な値（/v2/foo/weatherapi）に解決されるとしても、この変数にはその動的パス（/v2/*/weatherapi）が値として設定されます。

着信呼び出しの X-Forwarded-For アドレス。Edge が最後の外部 TCP handshake から受信した IP アドレスです。これは、呼び出し元クライアントかロードバランサのものである場合があります。

ProxyEndpoint に構成された名前属性。

クライアントから送信されて ProxyEndpoint で受信した、API プロキシ ベースパスの接尾辞の値。

ベースパスは、API プロキシを一意に識別するパス コンポーネントとして定義されます。API プロキシの公開 URL は、組織名、プロキシがデプロイされている環境、ベースパス、ベースパスの接尾辞、および任意のクエリ パラメータで構成されます。

たとえば、http://myorg-test.apigee.net/v2/weatherapi/forecastrss?w=12797282 へのリクエストでは、ペースパスの接尾辞は "/forecastrss" です。

存在するすべてのクエリ パラメータを含む、ProxyEndpoint で受信したプロキシ リクエストに関連付けられている完全な URL を取得します。

元のホストを使用して request URL を構成する例については、リクエスト メッセージにアクセスするをご覧ください。

存在するすべてのペイロードを含む、完全なリクエスト。

リクエスト メッセージのペイロードを取得または設定します。

クライアント アプリケーションから送信されたリクエストに含まれる、指定されたフォーム パラメータの値を取得または設定します。

リクエストに含まれる特定のフォーム パラメータのすべての値。カンマ区切りのリストとしてフォーマット化されます。

たとえば、ペイロードが "a=hello&x=greeting&a=world" の場合、request.formparam.a.values の値は "['hello', 'world']" になります。

リクエストに関連付けられている、指定されたフォーム パラメータのすべての値の合計数。

メッセージ内の特定の N 番目のフォーム パラメータの値。たとえば、フォーム文字列が "a=hello&a=world" の場合、request.formparam.a.1 は "hello" を返します。

クライアント アプリケーションから送信されたリクエストに関連付けられているフォーム パラメータの合計数。

リクエストに関連付けられているすべてのフォーム パラメータ名のリスト。

クライアント アプリから送信されたリクエストの完全な formparam。

例: "name=test&type=first&group=A"。

リクエスト内で検出された特定のヘッダーの値を取得または設定します。ヘッダーにカンマが含まれている場合は、読み取り時に、最初のカンマまでのテキスト セグメントのみが返されます。

ヘッダー全体が必要な場合は、request.header.header_name.values の形式を使用します。

リクエストに含まれる特定のヘッダーの N 番目の値。Apigee Edge は、ヘッダーのテキスト値をカンマで区切ります。値が N に使用されるインデックスの最初の値は 0 ではなく 1 です。

たとえば、Cache-control ヘッダーが "public, maxage=16544" の場合、request.header.cache-control.1 は "maxage=16544" を返します。

リクエストに含まれる特定のヘッダーのすべての値。

リクエストに含まれる特定のヘッダーのすべての値の合計数。

リクエストに含まれるすべてのヘッダーの合計数。

リクエストに含まれるすべてのヘッダーの名前。

クエリ パラメータを除いた、バックエンド サービスへのプロキシを使用しないリソースパス（ホストは含まれません）。

たとえば、バックエンド サービスへの URI が "https://example.com/rest/api/latest" の場合、request.path の値は "/rest/api/latest" になります。

リクエストで検出された特定のクエリ パラメータの値。

リクエスト内の N 番目のクエリ パラメータの値。

たとえば、request.querystring が "a=hello&a=world" の場合、request.queryparam.a.1 は "hello" を返します。

一例として、"type=siteid:1&type=language:us-en&type=currency:USD" のように単一のクエリ パラメータ名に複数の値を書き込むには、次のように設定します。

• request.queryparam.type.1 を "siteid:1" に設定
• request.queryparam.type.2 を "language:en-us" に設定
• request.queryparam.type.3 を "currency:USD" に設定

リクエストに含まれる特定のクエリ パラメータのすべての値。カンマ区切りのリストとしてフォーマット化されます。

たとえば、request.querystring が "a=hello&b=lovely&a=world" の場合、request.queryparam.a.values の値は "['hello', 'world']" になります。

リクエストに含まれる特定のクエリ パラメータのすべての値の合計数。

リクエストに含まれるすべてのクエリ パラメータの合計数。

リクエストに含まれるすべてのクエリ パラメータの名前。

JavaScript を使用してクエリ パラメータ名を反復処理するには、Apigee コミュニティで How do you iterate Collection from "request.queryparams.names" in JS? をご覧ください。

クライアント アプリから送信されたリクエストに含まれるクエリ パラメータの完全なリスト。

たとえば、リクエストが "http://host.com/123?name=first&surname=second&place=address" の場合、この変数は "name=first&surname=second&place=address" を返します。

コンテキスト依存オブジェクトである TransportMessage タイプのリクエストの ID。

コンテキスト依存オブジェクトである TransportMessage タイプのリクエスト。

API プロキシでは、ProxyEndpoint のプロキシ <BasePath> が（プロキシのベース URL に加えて）TargetEndpoint のターゲット サービス URL にマッピングされます。例:

<ProxyEndpoint>
...
  <BasePath>/my-mock-proxy</BasePath>

これは次を指しています。

<TargetEndpoint>
...
  <HTTPTargetConnection>
    http://mocktarget.apigee.net
  </HTTPTargetConnection>

リクエストでは、request.uri はプロキシのベースパスとアドレスの残りの部分（クエリ パラメータを含む）を合わせたものになります。

レスポンスでは、request.uri は、HTTPTargetConnection の後のアドレスの残りの部分（クエリ パラメータを含む）となります。

こうした違いが生じる理由は、元のリクエストはプロキシに取り込まれますが、プロキシはその後、ターゲット サービスに対して別のリクエストを送信するためです。

たとえば、ベースパスが "/my-mock-proxy" となっているサンプル プロキシに対して次の呼び出しを行うとします。

http://my_org-test.apigee.net/my-mock-proxy/user?user=Dude

プロキシは次の URL を呼び出します。

http://mocktarget.apigee.net

これにより、"/user?user=Dude" がその URL に追加されます。

• リクエスト: request.uri = "/my-mock-proxy/user?user=Dude"
• レスポンス: request.uri = "/user?user=Dude"

ターゲット エンドポイントに対して行われたリクエストの完全な URL。この URL にはクエリ文字列パラメータは含まれますが、ポート番号（指定されている場合）は含まれません。

たとえば、サンプル プロキシに対して "http://my_org-test.apigee.net/my-mock-proxy/user?user=Dude" を呼び出す場合、ターゲット エンドポイントが "http://example.com:8080" であれば、値は次のようになります。

• リクエスト: 適用外
• レスポンス: "http://example.com/user?user=Dude"

リクエストで使用された HTTP 動詞。例: "GET"、"PUT"、"DELETE" など。

リクエストの HTTP バージョン。例: "1.1"。

ターゲットから返された完全なレスポンス メッセージ。

ターゲットから返されたレスポンス メッセージのペイロードの内容。

レスポンスに含まれるフォーム パラメータの値。

レスポンスに含まれる、指定されたフォーム パラメータのすべての値の合計数。

レスポンスに含まれるすべてのフォーム パラメータの合計数。

レスポンスに含まれるすべてのフォーム パラメータの名前。

レスポンスに含まれる、指定された HTTP ヘッダーの値を取得または設定します。

ヘッダーのテキストにカンマが含まれている場合、Apigee Edge は複数の値があると推測します。この場合、response.header.header_name は最初の値のみを返します。

ヘッダー全体を読み取るには、response.header.header_name.values の形式を使用します。

レスポンスに含まれる、指定された HTTP ヘッダーのすべての値。

レスポンスに含まれる、指定された HTTP ヘッダーのすべての値の合計数。

レスポンスに含まれる特定のヘッダーの N 番目の値。Apigee Edge は、ヘッダーのテキスト値をカンマで区切ります。値が N に使用されるインデックスの最初の値は 0 ではなく 1 です。

たとえば、Cache-control ヘッダーが "public, maxage=16544" の場合、response.header.cache-control.1 は "maxage=16544" を返します。

レスポンスに含まれるすべてのヘッダーの合計数。

レスポンスに含まれるすべてのヘッダーの名前。

特定のリクエストに対するレスポンスの理由句。

リクエストに対して返されたレスポンス コード。この変数を使用して、message.status.code に保存されているレスポンス ステータス コードをオーバーライドできます。詳細については、message をご覧ください。

コンテキスト依存オブジェクトである TransportMessage タイプのレスポンス。

ProxyEndpoint で実行された <RouteRule> の名前。例: "default"。RouteRule は、実行対象の API プロキシ TargetEndpoint を参照します。

実行された TargetEndpoint の名前。例: "default"。

非推奨であり、null を返します（以前は、プロキシを処理する Router の UUID が返されました）。

ServiceCallout policy ポリシーで参照される TargetEndpoinnt の予期される一般名。これは、TargetEndpoint が TLS / SSL エンドポイントを参照している場合にのみ意味があります。

特定の ServiceCallout ポリシーの TargetEndpoint URL。

ServiceCallout ポリシーの TargetEndpoint URI。この URI は、プロトコルとドメインの指定を除く TargetEndpoint URL です。

システムの IP アドレス。

プロキシが稼働しているポッドの名前。

プロキシが稼働しているデータセンターのリージョンの名前。

この変数が読み取られた時刻。例: "Wed, 21 Aug 2013 19:16:47 UTC"。

この値は、対応する system.timestamp の値の文字列表現です。たとえば、"Wed, 21 Aug 2013 19:16:47 UTC" はタイムスタンプ値 1377112607413 に相当します。

system.time の年の部分。

system.time の月の部分。

system.time の日付の部分。

system.time の曜日の部分。

system.time の時間の部分。

system.timeの分の部分。

system.timeの 2 番目の部分。

system.time のミリ秒の部分。

システムのタイムゾーン。

この変数が読み取られた時刻を表す 64 ビット（long 型）の整数。この値は、1970 年 1 月 1 日の午前 0 時（UTC）から経過したミリ秒数です。例: "1534783015000"。

プロキシを処理する Message Processor の UUID。

クエリ パラメータを除く、ターゲット サービスへのリソースパス（ドメインは含まれません）。このリソースパスは、プロキシの TargetEndpoint で定義されているものです。

たとえば、API プロキシが次のターゲットを呼び出すとします。

<TargetEndpoint name="default">
...
  <HTTPTargetConnection>
    <URL>http://mocktarget.apigee.net/user?user=Dude</URL>
  </HTTPTargetConnection>

この例では、target.basepath は "/user" です。

ターゲットが次のようになっているとします。

<TargetEndpoint name="default">
...
  <HTTPTargetConnection>
    <URL>http://mocktarget.apigee.net</URL>
  </HTTPTargetConnection>

target.basepath は null です。

"true"の場合、ProxyEndpoint から TargetEndpoint に転送されるリクエストで、パスの接尾辞（ProxyEndpoint のベースパスで定義された URI の後に続く URI パスのフラグメント）が保持されます。

"true" の場合、ProxyEndpoint から TargetEndpoint に転送されるリクエストでクエリ パラメータが保持されます。

ターゲット サーバーから提示された TLS / SSL 証明書に示されている国。

TargetEndpoint の共通名。これは、TargetEndpoint が TLS / SSL エンドポイントを参照している場合にのみ意味があります。

ターゲット サーバーから提示された TLS / SSL 証明書に示されているメールアドレス。

TargetEndpoint に期待される共通名。これは、TargetEndpoint が TLS / SSL エンドポイントを参照している場合にのみ意味があります。

API プロキシにレスポンスを返しているターゲット サービスのドメイン名。

API プロキシにレスポンスを返しているターゲット サービスの IP アドレス。

ターゲット サーバーから提示された TLS / SSL 証明書に示されている地域（市区町村）。

TargetEndpoint からのメッセージが到達するターゲット。

ターゲット サーバーから提示された TLS / SSL 証明書に示されている組織。

ターゲット サーバーから提示された TLS / SSL 証明書に示されている組織単位。

API プロキシにレスポンスを返しているターゲット サービスのポート番号。

TargetEndpoint がターゲットからのレスポンス受信を完了した時刻。文字列形式で表記されます。例: "Wed, 21 Aug 2013 19:16:47 UTC"。

この時間値は、対応する 32 ビット タイムスタンプの数値の文字列表現です。たとえば、"Wed, 21 Aug 2013 19:16:47 UTC" はタイムスタンプ値 1377112607413 に相当します。

TargetEndpoint がターゲットからのレスポンス受信を完了した時刻を示すタイムスタンプ値。例: "1534783015000"。この値は、1970 年 1 月 1 日午前 0 時（UTC）からの経過時間（ミリ秒数）を示す 64 ビット（long 型）の整数です。

TargetEndpoint がターゲットからのレスポンス受信を開始した時刻。文字列形式で表記されます。例: "Wed, 21 Aug 2013 19:16:47 UTC"。

この時間値は、対応する 32 ビット タイムスタンプの数値の文字列表現です。たとえば、"Wed, 21 Aug 2013 19:16:47 UTC" はタイムスタンプ値 1377112607413 に相当します。

TargetEndpoint がターゲットからのレスポンス受信を開始した時刻を示すタイムスタンプ値。例: "1534783015000"。この値は、1970 年 1 月 1 日午前 0 時（UTC）からの経過時間（ミリ秒数）を示す 64 ビット（long 型）の整数です。

スコープの開始: ターゲット レスポンス
型: 文字列
権限: 読み取り / 書き込み

リクエスト メッセージに応じて、http または https を返します。

プロキシが TargetEndpoint で指定された URL へのリクエスト送信を停止した時刻。文字列形式で表記されます。例: "Wed, 21 Aug 2013 19:16:47 UTC"。

この時間値は、対応する 32 ビット タイムスタンプの数値の文字列表現です。たとえば、"Wed, 21 Aug 2013 19:16:47 UTC" はタイムスタンプ値 1377112607413 に相当します。

プロキシが TargetEndpoint で指定された URL へのリクエスト送信を停止した時刻を示すタイムスタンプ値。例: "1377112607413"。この値は、1970 年 1 月 1 日午前 0 時（UTC）からの経過時間（ミリ秒数）を含んだ 64 ビット（long 型）の整数です。

プロキシが TargetEndpoint で指定された URL へのリクエスト送信を開始した時刻。文字列形式で表記されます。例: "Wed, 21 Aug 2013 19:16:47 UTC"。

この時間値は、対応する 32 ビット タイムスタンプの数値の文字列表現です。たとえば、"Wed, 21 Aug 2013 19:16:47 UTC" はタイムスタンプ値 1377112607413 に相当します。

プロキシが TargetEndpoint で指定された URL へのリクエスト送信を開始した時刻を示すタイムスタンプ値。例: "1534783015000"。この値は、1970 年 1 月 1 日午前 0 時（UTC）からの経過時間（ミリ秒数）を示す 64 ビット（long 型）の整数です。

TargetEndpoint が TLS / SSL で実行されているかどうか。

ターゲット サーバーから提示された TLS / SSL 証明書に示されている状態。

TargetEndpoint XML ファイルで構成された URL または動的ターゲット URL（メッセージ フロー中に target.url が設定されている場合）。この変数には、追加のパス要素やクエリ パラメータは保存されません。スコープ外で呼び出された場合、あるいは未設定の場合は null を返します。

TLS / SSL で実行される場合、共通名として公開されている変数。

特定のリクエスト実行中にアクセスした仮想ホストのホスト エイリアス。

発信元クライアント リクエストに対応する仮想ホストの名前。

仮想ホストの構成で TLS / SSL が有効にされている場合は "true" を返します。