このページの内容は Apigee と Apigee ハイブリッドに該当します。
Apigee Edge のドキュメントを表示する。
このセクションでは、フロー変数のリファレンス情報を提供します。
Apigee では次のフロー変数が定義されています。
apigee
is
request
apiproduct
loadbalancing
response
apiproxy
message
route
client
messageid
servicecallout
current
mint
system
environment
organization
target
error
proxy
variable
fault
publishmessage
graphql
ratelimit
以降のセクションで、それぞれの変数について説明します。
apigee
ポリシーの実行時間に関する情報を提供するヘルパー変数。
次の表に、apigee
変数のプロパティを示します。
プロパティ | 型 | 読み取りと書き込み | 説明 | スコープの開始 |
---|---|---|---|---|
apigee.metrics.policy.policy_name.timeTaken |
整数 | 読み取り専用 | ポリシーの実行にかかった時間(ナノ秒)。 | ポリシー |
apiproduct
API プロダクトに関する情報を提供するヘルパー変数。
次の表に、apiproduct
変数のプロパティを示します。
プロパティ | 型 | 読み取りと書き込み | 説明 | スコープの開始 |
---|---|---|---|---|
apiproduct.operation |
文字列 | 読み取り専用 |
API プロダクトの操作名。Quota ポリシーの設定と API プロダクトの操作の割り当て設定を区別するのに役立ちます。 例: |
プロキシ リクエスト |
apiproduct.operation.resource |
文字列 | 読み取り専用 |
リクエストに合致する操作のリソース名。 |
プロキシ リクエスト |
apiproduct.operation.methods |
配列 | 読み取り専用 |
合致する操作が許可する HTTP メソッドの配列。 |
プロキシ リクエスト |
apiproduct.operation.attributes.key_name |
配列 | 読み取り専用 |
key_name に合致するカスタム属性の値を取得します。 |
プロキシ リクエスト |
詳しくは以下をご覧ください。
apiproxy
API プロキシを記述します。
次の表に、apiproxy
変数のプロパティを示します。
プロパティ | 型 | 読み取りと書き込み | 説明 | スコープの開始 |
---|---|---|---|---|
apiproxy.name |
文字列 | 読み取り専用 | API プロキシの名前。例: My Proxy |
プロキシ リクエスト |
apiproxy.revision |
文字列 | 読み取り専用 | API プロキシのリビジョン番号。例: 6 |
プロキシ リクエスト |
apiproxy.basepath |
文字列 | 読み取り専用 | デプロイベースのパス(API のデプロイ時に指定されたもの)。 | プロキシ リクエスト |
API プロキシの操作の詳細については、API と API プロキシについてをご覧ください。
client
ロードバランサにリクエストを送信したアプリケーションまたはシステム。
次の表に、client
変数のプロパティを示します。
プロパティ | 型 | 読み取りと書き込み | 説明 | スコープの開始 |
---|---|---|---|---|
client.cn |
文字列 | 読み取り専用 |
クライアント アプリから提示された TLS / SSL 証明書に示されている共通名。 |
プロキシ リクエスト |
client.country |
文字列 | 読み取り専用 |
クライアント アプリから提示された TLS / SSL 証明書に示されている国。 |
プロキシ リクエスト |
client.email.address |
文字列 | 読み取り専用 |
クライアント アプリから提示された TLS / SSL 証明書に示されているメールアドレス。 |
プロキシ リクエスト |
client.host |
文字列 | 読み取り専用 |
ProxyEndpoint で受信したリクエストに関連付けられている HTTP ホスト IP。 |
プロキシ リクエスト |
client.ip |
文字列 | 読み取り専用 |
ロードバランサにメッセージを送信しているクライアントまたはシステムの IP アドレス。たとえば、元のクライアントの IP であることも、ロードバランサの IP であることもあります。 |
プロキシ リクエスト |
client.locality |
文字列 | 読み取り専用 |
クライアントから提示された TLS / SSL 証明書に示されている地域(市区町村)。 |
プロキシ リクエスト |
client.organization |
文字列 | 読み取り専用 | クライアントから提示された TLS / SSL 証明書に示されている組織(必ずしも Apigee 上の組織に相当するわけではありません)。 | プロキシ リクエスト |
client.organization.unit |
文字列 | 読み取り専用 |
クライアントから提示された TLS / SSL 証明書に示されている組織単位。 |
プロキシ リクエスト |
client.port |
整数 | 読み取り専用 |
ProxyEndpoint に送信されたクライアント リクエストに関連付けられている HTTP ポート。 |
プロキシ リクエスト |
client.received.end.time |
文字列 | 読み取り専用 |
プロキシが ProxyEndpoint で発信元クライアントからのリクエストの受信を完了した時刻。文字列形式で表記されます。例: Wed, 21 Aug 2013 19:16:47 UTC。 この時刻値は、対応する 32 ビット タイムスタンプの数値の文字列表現です。たとえば、「Wed, 21 Aug 2013 19:16:47 UTC」はタイムスタンプ値 1377112607413 に相当します。 |
プロキシ リクエスト |
client.received.end.timestamp |
Long 型 | 読み取り専用 |
プロキシが ProxyEndpoint で発信元クライアントからのリクエストの受信を完了した時刻を示すタイムスタンプ値。この値は、1970 年 1 月 1 日午前 0 時(UTC)からの経過時間(ミリ秒)を含んだ 64 ビット(long 型)の整数です。 |
プロキシ リクエスト |
client.received.start.time |
文字列 | 読み取り専用 |
プロキシが ProxyEndpoint で発信元クライアントからのリクエスト受信を開始した時刻。文字列形式で表記されます。例: Wed, 21 Aug 2013 19:16:47 UTC。 この時刻値は、対応する 32 ビット タイムスタンプの数値の文字列表現です。たとえば、「Wed, 21 Aug 2013 19:16:47 UTC」はタイムスタンプ値 1377112607413 に相当します。 |
プロキシ リクエスト |
client.received.start.timestamp |
Long 型 | 読み取り専用 |
プロキシが ProxyEndpoint で発信元クライアントからのリクエスト受信を開始した時刻を示すタイムスタンプ値。この値は、1970 年 1 月 1 日午前 0 時(UTC)からの経過時間(ミリ秒)を含んだ 64 ビット(long 型)の整数です。 |
プロキシ リクエスト |
client.scheme |
文字列 | 読み取り専用 |
クライアント アプリがリクエスト メッセージの送信に使用するトランスポートに応じて、HTTP または HTTPS を返します。 |
プロキシ リクエスト |
client.sent.end.time |
文字列 | 読み取り専用 |
プロキシが ProxyEndpoint からクライアントへのレスポンス送信を完了した時刻。文字列形式で表記されます。例: Wed, 21 Aug 2013 19:16:47 UTC。 この値は、対応する 32 ビットの |
PostClientFlow |
client.sent.end.timestamp |
Long 型 | 読み取り専用 | ProxyEndpoint が発信元クライアント アプリへのレスポンス返信を完了した時刻を示すタイムスタンプ値。この値は、1970 年 1 月 1 日午前 0 時(UTC)からの経過時間(ミリ秒)を含んだ 64 ビット(long 型)の整数です。 | PostClientFlow |
client.sent.start.time |
文字列 | 読み取り専用 | ProxyEndpoint で発信元クライアント アプリへのレスポンス返信を開始した時刻。文字列形式で表記されます。例: Wed, 21 Aug 2013 19:16:47 UTC。 この値は、対応する 32 ビットの |
PostClientFlow |
client.sent.start.timestamp |
Long 型 | 読み取り専用 | プロキシが ProxyEndpoint からクライアントへのレスポンス送信を開始した時刻。この値は、1970 年 1 月 1 日午前 0 時(UTC)からの経過時間(ミリ秒)を含む 64 ビット(long 型)の整数です。 | PostClientFlow |
client.ssl.enabled |
文字列 | 読み取り専用 |
ProxyEndpoint が TLS / SSL 用に構成されている場合は |
プロキシ リクエスト |
client.state |
文字列 | 読み取り専用 |
クライアントから提示された TLS / SSL 証明書に示されている状態。 |
プロキシ リクエスト |
current
現在の API プロキシフローに関する情報が保存されます。
次の表に、current
変数のプロパティを示します。
プロパティ | 型 | 読み取りと書き込み | 説明 | スコープの開始 |
---|---|---|---|---|
current.flow.name |
文字列 | 読み取り専用 | 現在実行中のフローの名前(PreFlow 、PostFlow 、条件付きフローの名前など)。 |
プロキシ リクエスト |
current.flow.description |
文字列 | 読み取り専用 | 現在実行されているフローの説明。これは、フローの XML 構成内の <Description> 要素の値と同じです。 |
プロキシ リクエスト |
これらのプロパティは、Apigee UI の [Trace] ビューで確認できます。
environment
environment.name
プロパティのコンテナ。
次の表に、environment
変数のプロパティを示します。
プロパティ | 型 | 読み取りと書き込み | 説明 | スコープの開始 |
---|---|---|---|---|
environment.name |
文字列 | 読み取り専用 | トランザクションが実行された環境の名前。 | プロキシ リクエスト |
error
エラーフローのエラー メッセージを表すコンテキスト オブジェクト。
次の表に、error
変数のプロパティを示します。
プロパティ | 型 | 読み取りと書き込み | 説明 | スコープの開始 |
---|---|---|---|---|
error |
message |
読み取りと書き込み | message タイプのエラー。これはエラーフローのコンテキスト オブジェクトです。 |
エラー |
error.content |
文字列 | 読み取りと書き込み | エラーの内容。 | エラー |
error.message |
文字列 | 読み取り専用 |
エラーに関連付けられているメッセージ。このプロパティの値は、エラーフローの実行前にのみ使用できます。 |
エラー |
error.status.code |
整数 | 読み取り専用 |
エラーに関連付けられている HTTP ステータス コード。例: |
エラー |
error.reason.phrase |
文字列 | 読み取り専用 |
エラーに関連付けられている理由フレーズ。例: |
エラー |
error.transport.message |
TransportMessage | 読み取り専用 |
|
エラー |
error.state |
整数 | 読み取り専用 |
エラーが発生したフロー内での状態。 |
エラー |
error.header.header_name |
文字列 | 読み取りと書き込み |
レスポンス ヘッダーを取得または設定します。 |
エラー |
fault
ランタイム エラーの発生元、理由、詳細に関する情報を提供します。Apigee では、ポリシーによってエラーがスローされるときに、以下の変数を設定します。値は、各ポリシーに固有のものです。fault
変数が設定されているタイミングについては、ポリシーエラーについてをご覧ください。
プロパティ | 型 | 読み取りと書き込み | 説明 | スコープの開始 |
---|---|---|---|---|
fault.name |
文字列 | 読み取り専用 | 各ポリシー リファレンスのトピックに含まれるランタイム エラーの表で説明されている障害の名前。この変数は、FaultRules に適用される Conditions で使用できます。 | エラー |
fault.reason |
文字列 | 読み取り専用 | 障害の理由。たとえば、OASValidation ポリシーは、インバウンド リクエストが OpenAPI 仕様に照らして検証されないことを検出すると、この変数に、ポリシー名(仕様名)と、リクエストが仕様に照らして検証されない理由の詳細を記述する文字列を設定します。他のポリシーでは、この変数は障害に適したメッセージに設定されます。 | エラー |
fault.category |
文字列 | 読み取り専用 | カテゴリ。たとえば、ポリシーのステップで障害が発生した場合、この変数に値「Step」が保持されます。この変数は、FaultRules に適用される Conditions で使用できます。 | エラー |
fault.subcategory |
文字列 | 読み取り専用 | サブカテゴリ。たとえば、OASValidation ポリシーは、OpenAPI 仕様に照らしてリクエストの検証が行われないことを検出すると、この変数を「OASValidationFailure」に設定します。この変数は、FaultRules に適用される Conditions で使用できます。 | エラー |
graphql
実行時の GraphQL クエリの結果にアクセスできます。詳細については、GraphQL ポリシーをご覧ください。
次の表に、graphql
変数のプロパティを示します。
プロパティ | 型 | 読み取りと書き込み | 説明 | |
---|---|---|---|---|
graphql |
複合型 | 読み取り専用 / 読み書き | ルートレベルの GraphQL クエリ。 | スコープ |
graphql.fragment |
複合型 | 読み取り専用 / 読み書き | このクエリのデフォルト フラグメントへの参照。 | スコープ |
graphql.fragment.count |
整数 | 読み取り専用 | この GraqhQL クエリによって生成されたフラグメントの数。 | スコープ |
graphql.fragment.INDEX.selectionSet.INDEX |
型 | 読み取り専用 / 読み書き | 指定されたインデックスにある選択セットへの参照。 | スコープ |
graphql.fragment.INDEX.selectionSet.INDEX.name |
文字列 | 読み取り専用 / 読み書き | 指定されたインデックスにある選択セットの名前。 | スコープ |
graphql.fragment.INDEX.selectionSet.count |
整数 | 読み取り専用 | このフラグメント内の選択セットの数。 | スコープ |
graphql.fragment.INDEX.selectionSet.name |
文字列 | 読み取り専用 / 読み書き | フラグメントで設定されたデフォルトの選択セットの名前。 | スコープ |
graphql.operation |
複合型 | 読み取り専用 / 読み書き | クエリのデフォルト操作への参照。 操作レベルでは割り当てを設定できません。代わりに、環境レベルで設定します。 |
スコープ |
graphql.operation.name |
文字列 | 読み取り専用 | クエリのデフォルト オペレーションの名前。 | スコープ |
graphql.operation.operationType |
列挙 | 読み取り専用 | この API プロキシに対して実行できるクエリのデフォルト オペレーションのタイプ。指定可能な値は query 、mutation 、all です。 |
スコープ |
graphql.operation.selectionSet |
複合型 | クエリのデフォルト操作のデフォルトの選択セット。 | スコープ | |
graphql.operation.selectionSet.count |
整数 | 読み取り専用 | クエリのデフォルト操作内の選択セットの数。 | スコープ |
graphql.operation.selectionSet.name |
文字列 | 読み取り専用 | クエリのデフォルト操作のデフォルト選択セットの名前。 | スコープ |
graphql.operation.selectionSet.INDEX |
整数 | 読み取り専用 | 選択セットのリスト内の指定されたインデックスにある選択セットへの参照。 | スコープ |
graphql.operation.selectionSet.INDEX.name |
文字列 | 読み取り専用 | この操作の選択セットのリスト内の指定されたインデックスにある選択セットの名前。 | スコープ |
graphql.operation.selectionSet.INDEX.[selectionSet] |
複合型 | 読み取り専用 / 読み書き | 1 つ以上の追加の選択セット オブジェクト。 選択セットには再帰的にアクセスできます。たとえば、 | スコープ |
graphql.operation.selectionSet.INDEX.directive |
複合型 | 指定された選択セット内のデフォルト ディレクティブへの参照。 | スコープ | |
graphql.operation.selectionSet.INDEX.directive.count |
複合型 | スコープ | ||
graphql.operation.selectionSet.INDEX.directive.INDEX |
整数 | 読み取り専用 | 指定されたインデックスにあるディレクティブへの参照。 | スコープ |
graphql.operation.selectionSet.INDEX.directive.INDEX.argument.INDEX |
整数 | 読み取り専用 | 指定されたインデックスにある引数への参照。 | スコープ |
graphql.operation.selectionSet.INDEX.directive.INDEX.argument.INDEX.name |
文字列 | 指定されたインデックスにある引数の名前。 | スコープ | |
graphql.operation.selectionSet.INDEX.directive.INDEX.argument.INDEX.value |
文字列 | 指定されたインデックスにある引数の値。 | スコープ | |
graphql.operation.selectionSet.INDEX.directive.name |
文字列 | スコープ | ||
graphql.operation.variableDefinitions |
複合型 | クエリのデフォルト操作の変数定義のリストへの参照。 | スコープ | |
graphql.operation.variableDefinitions.count |
整数 | クエリのデフォルト操作の変数定義の数。 | スコープ | |
graphql.operation.variableDefinitions.INDEX |
整数 | 指定されたインデックスにある変数定義への参照。 | スコープ | |
graphql.operation.variableDefinitions.INDEX.name |
文字列 | 指定されたインデックスにある変数定義の名前。 | スコープ | |
graphql.operation.variableDefinitions.INDEX.type |
指定されたインデックスにある変数定義の値の型。 | スコープ |
is
is.error
プロパティのコンテナ。
次の表に、is
変数のプロパティを示します。
プロパティ | 型 | 読み取りと書き込み | 説明 | スコープの開始 |
---|---|---|---|---|
is.error |
ブール値 | 読み取り専用 |
エラーフラグ。 |
プロキシ リクエスト |
loadbalancing
TargetEndpoint のロード バランシングのステータスに関する情報を提供します。
次の表に、loadbalancing
変数のプロパティを示します。
プロパティ | 型 | 読み取りと書き込み | 説明 | スコープの開始 |
---|---|---|---|---|
loadbalancing.failedservers |
文字列の配列 | 読み取り専用 |
TargetEndpoint でのロード バランシング中にエラーが発生した TargetServer のリスト。 |
ターゲット レスポンス |
loadbalancing.isfallback |
ブール値 | 読み取り専用 |
TargetEndpoint でのロード バランシング中に呼び出された TargetServer に対してフォールバックが有効にされている場合は |
ターゲット レスポンス |
loadbalancing.targetserver |
文字列 | 読み取り専用 |
TargetEndpoint でのロード バランシング中に呼び出された TargetServer。ロードバランサ要素の定義時に |
ターゲット レスポンス |
message
コンテキスト オブジェクト。リクエスト フローの request
と同じ値、レスポンス フローの response
と同じ、またはエラーフローの error
を使用します。
次の表に、message
変数のプロパティを示します。
プロパティ | 型 | 読み取りと書き込み | 説明 | スコープの開始 |
---|---|---|---|---|
message |
message |
読み取りと書き込み |
リクエスト フローでは |
プロキシ リクエスト |
message.content |
文字列 | 読み取りと書き込み |
リクエスト、レスポンス、またはエラー メッセージの内容。 |
プロキシ リクエスト |
message.formparam.param_name |
文字列 | 読み取りと書き込み |
指定されたフォーム パラメータの値。 |
プロキシ リクエスト |
message.formparam.param_name. |
コレクション | 読み取り専用 |
メッセージに含まれる、指定されたフォーム パラメータのすべての値。 |
プロキシ リクエスト |
message.formparam.param_name. |
整数 | 読み取り専用 |
メッセージに含まれる、指定されたフォーム パラメータの値の数。 |
プロキシ リクエスト |
message.formparams.count |
整数 | 読み取り専用 |
メッセージに含まれるすべてのフォーム パラメータの合計数。 |
プロキシ リクエスト |
message.formparams.names |
コレクション | 読み取り専用 |
メッセージに含まれるすべてのフォーム パラメータの値。 |
プロキシ リクエスト |
message.formparams.names.string |
文字列 | 読み取り専用 |
メッセージに含まれるすべてのフォーム パラメータの名前のカンマ区切りリスト。 |
プロキシ リクエスト |
message.formstring |
文字列 | 読み取り専用 |
メッセージに含まれるフォーム文字列の値。 |
プロキシ リクエスト |
message.header.header_name |
文字列 | 読み取りと書き込み |
リクエストに含まれる特定のヘッダーの値を取得または設定します。ヘッダーにカンマが含まれている場合は、読み取り時に、最初のカンマまでのテキスト セグメントのみが返されます。 たとえば、 文字列としてヘッダー全体が必要な場合は、 |
プロキシ リクエスト |
message.header.header_name.N |
文字列 | 読み取りと書き込み |
フローの状態に応じて、リクエストまたはレスポンスのメッセージに含まれる特定のヘッダーの N 番目の値。Apigee は、ヘッダーのテキスト値をカンマで区切ります。インデックスの左端の値は 1 から始まります。 たとえば、 |
プロキシ リクエスト |
message.header.header_name. |
コレクション | 読み取り専用 |
メッセージに含まれる、指定された HTTP ヘッダー名のすべての値。 |
プロキシ リクエスト |
message.header.header_name. |
整数 | 読み取り専用 |
メッセージに含まれる、指定された HTTP ヘッダー名の値の数。 |
プロキシ リクエスト |
message.header.header_name. |
文字列 | 読み取り専用 |
メッセージ内の特定のヘッダーのすべての値(単一文字列形式)。 たとえば、 |
プロキシ リクエスト |
message.headers.count |
整数 | 読み取り専用 |
メッセージに含まれるすべての HTTP ヘッダーの合計数。 |
プロキシ リクエスト |
message.headers.names |
コレクション | 読み取り専用 |
メッセージに含まれるすべての HTTP ヘッダーの値。 |
プロキシ リクエスト |
message.headers.names.string |
文字列 | 読み取り専用 |
メッセージに含まれるすべてのヘッダーの名前のカンマ区切りリスト。 |
プロキシ リクエスト |
message.path |
文字列 | 読み取りと書き込み |
クエリ パラメータを除く、URL の完全なリクエスト メッセージパス。 |
プロキシ リクエスト |
message.queryparam.param_name |
文字列 | 読み取り専用 |
指定されたメッセージ クエリ パラメータを返します。 |
プロキシ リクエスト |
message.queryparam.param_name.N |
文字列 | 読み取りと書き込み |
メッセージ内の N 番目のクエリ パラメータの値。たとえば、 たとえば、
|
プロキシ リクエスト |
message.queryparam.param_name. |
コレクション | 読み取り専用 |
メッセージ内の特定のクエリ パラメータのすべての値(カンマ区切りリスト形式)。 たとえば、クエリ文字列が |
プロキシ リクエスト |
message.queryparam.param_name. |
整数 | 読み取り専用 |
クライアント アプリから ProxyEndpoint に送信されたリクエストに関連付けられている、指定されたクエリ パラメータの合計数。 |
プロキシ リクエスト |
message.queryparams.count |
整数 | 読み取り専用 |
クライアント アプリから ProxyEndpoint に送信されたリクエストに関連付けられているすべてのクエリ パラメータの合計数。 |
プロキシ リクエスト |
message.queryparams.names |
コレクション | 読み取り専用 |
クライアント アプリから ProxyEndpoint に送信されたリクエストに関連付けられているすべてのクエリ パラメータ名のリスト。 |
プロキシ リクエスト |
message.queryparams.names.string |
文字列 | 読み取り専用 |
メッセージに含まれるすべてのクエリ パラメータの名前のカンマ区切りリスト。 |
プロキシ リクエスト |
message.querystring |
文字列 | 読み取り専用 |
クライアント アプリから ProxyEndpoint に送信されたリクエストに関連付けられたすべてのクエリ パラメータの名前と値を含む文字列。 たとえば、リクエスト |
プロキシ リクエスト |
message.status.code |
整数 | 読み取り専用 |
ターゲットから返されたレスポンス メッセージの HTTP ステータス コード。 |
ターゲット レスポンス |
message.transport.message |
TransportMessage | 読み取り専用 |
コンテキスト依存オブジェクトである TransportMessage 型のメッセージ。 |
プロキシ リクエスト |
message.uri |
文字列 | 読み取り専用 |
クエリ パラメータを含む完全な URI パス(ドメイン URL に続く部分)。 たとえば、リクエスト |
プロキシ リクエスト |
message.verb |
文字列 | 読み取り専用 |
リクエストに関連付けられた HTTP 動詞( |
プロキシ リクエスト |
message.version |
文字列 | 読み取りと書き込み |
クライアント アプリケーションから ProxyEndpoint に送信されたリクエストに関連付けられている HTTP バージョン。 |
プロキシ リクエスト |
メッセージの詳細については、メッセージ テンプレート関数リファレンスをご覧ください。
messageid
グローバルに一意なリクエスト ID のコンテナ。
次の表に、messageid
変数のプロパティを示します。
プロパティ | 型 | 読み取りと書き込み | 説明 | スコープの開始 |
---|---|---|---|---|
messageid |
文字列 | 読み取り専用 |
ロードバランサ ホスト名が含まれる、リクエストのグローバルに一意な ID を保存します。ロードバランサで受信したリクエストを Message Processor に送信した後、この ID を使用して、そのリクエストをトラッキングできます。 この ID は、 |
プロキシ リクエスト |
mint
収益化に関する情報を提供するヘルパー変数。
次の表に、mint
変数のプロパティを示します。
プロパティ | 型 | 読み取りと書き込み | 説明 | スコープの開始 |
---|---|---|---|---|
mint.limitscheck.is_request_blocked |
ブール値 | 読み取り専用 |
API リクエストがブロックされるかどうかを指定するフラグ。 このフロー変数は、MonetizationLimitsCheck ポリシーが API プロキシに接続されている場合に利用できます。API プロキシでの収益化の上限の適用をご覧ください。 |
プロキシ リクエスト |
mint.limitscheck.is_subscription_found |
ブール値 | 読み取り専用 |
デベロッパーが API プロダクトのアクティブ サブスクリプションを保有しているかどうかを指定するフラグ。デベロッパーがサブスクリプションを保有している場合は このフロー変数は、MonetizationLimitsCheck ポリシーが API プロキシに接続されている場合に利用できます。API プロキシでの収益化の上限の適用をご覧ください。 |
プロキシ リクエスト |
mint.limitscheck.prepaid_developer_balance |
数値 | 読み取り専用 |
料金プランの通貨に関連付けられた、デベロッパーの前払いアカウント ウォレットの現在の残高。 |
プロキシ リクエスト |
mint.limitscheck.prepaid_developer_currency |
文字列 | 読み取り専用 |
|
プロキシ リクエスト |
mint.limitscheck.purchased_product_name |
文字列 | 読み取り専用 |
関連する API プロダクトの名前。 このフロー変数は、MonetizationLimitsCheck ポリシーが API プロキシに接続されている場合に利用できます。API プロキシでの収益化の上限の適用をご覧ください。 |
プロキシ リクエスト |
mint.limitscheck.status_message |
文字列 | 読み取り専用 |
デバッグに使用できる、MonetizationLimitsCheck ポリシーの実行に関する追加情報。 このフロー変数は、MonetizationLimitsCheck ポリシーが API プロキシに接続されている場合に利用できます。API プロキシでの収益化の上限の適用をご覧ください。 |
プロキシ リクエスト |
mint.mintng_consumption_pricing_rates |
文字列 | 読み取り専用 |
使用量に基づく料金。 料金プランの作成時に料金を設定してください。 |
PostClientFlow |
mint.mintng_consumption_pricing_type |
文字列 | 読み取り専用 |
使用量に基づく料金タイプ。例: 料金プランの作成時に、使用量に基づく料金を設定してください。 |
PostClientFlow |
mint.mintng_currency |
文字列 | 読み取り専用 |
収益の計算に使用する通貨。 このフロー変数には、収益化変数 |
DataCapture ポリシー |
mint.mintng_dev_share |
数値 | 読み取り専用 |
デベロッパーに分配する収益。 料金プランの作成時に、デベロッパーに配分する収益を設定してください。 |
PostClientFlow |
mint.mintng_is_apiproduct_monetized |
ブール値 | 読み取り専用 |
API プロダクトが現在収益化されているかどうか(つまり、有効な料金プランが存在するかどうか)を指定するフラグ。 このフロー変数は、API プロキシに接続された VerifyAPIKey ポリシーまたは VerifyAccessToken ポリシーによって追加されます。認証ポリシーの追加をご覧ください。 |
プロキシ リクエスト |
mint.mintng_price |
数値 | 読み取り専用 |
デベロッパーに分配する料金の計算に使用する収益。 このフロー変数には、収益化変数 |
DataCapture ポリシーと PostClientFlow |
mint.mintng_price_multiplier |
数値 | 読み取り専用 |
トランザクションごとの費用にかける係数(乗数)。 このフロー変数には、収益化変数 |
DataCapture ポリシーと PostClientFlow |
mint.mintng_rate |
数値 | 読み取り専用 |
API 呼び出しに対して課金される料金。 このフロー変数は、API 呼び出しごとの使用量ベースの料金を示します。料金プランの作成時に、使用量に基づく料金を設定してください。DataCapture ポリシーで収益化変数 |
PostClientFlow |
mint.mintng_rate_before_multipliers |
数値 | 読み取り専用 |
DataCapture ポリシーで 収益化変数 |
PostClientFlow |
mint.mintng_rate_plan_id |
文字列 | 読み取り専用 |
料金プランの ID。 このフロー変数は、API プロキシに接続された VerifyAPIKey ポリシーまたは VerifyAccessToken ポリシーによって追加されます。認証ポリシーの追加をご覧ください。 |
プロキシ リクエスト |
mint.mintng_revenue_share_rates |
文字列 | 読み取り専用 |
収益分配率。 料金プランの作成時に、収益分配率を設定してください。 |
PostClientFlow |
mint.mintng_revenue_share_type |
文字列 | 読み取り専用 |
収益分配率のタイプ。例: 料金プランの作成時に、収益分配タイプを設定してください。 |
PostClientFlow |
mint.mintng_tx_success |
ブール値 | 読み取り専用 |
トランザクションを収益化するかどうかを指定します。 このフロー変数には、収益化変数 |
DataCapture ポリシー |
mint.prepaid_updated_developer_usage |
数値 | 読み取り専用 |
前払いデベロッパーの現在の使用量。 使用量は、料金プランの構成と、perUnitPriceMultiplier 収益化変数の値に基づいて計算されます。 |
PostClientFlow |
mint.rateplan_end_time_ms |
数値 | 読み取り専用 |
料金プランが有効にされる時点であるエポックからのミリ秒単位の有効期限。 このフロー変数は、API プロキシに接続された VerifyAPIKey ポリシーまたは VerifyAccessToken ポリシーによって追加されます。認証ポリシーの追加をご覧ください。 |
プロキシ リクエスト |
mint.rateplan_start_time_ms |
数値 | 読み取り専用 |
料金プランが有効にされる時点であるエポックからのミリ秒単位の経過時間。 このフロー変数は、API プロキシに接続された VerifyAPIKey ポリシーまたは VerifyAccessToken ポリシーによって追加されます。認証ポリシーの追加をご覧ください。 |
プロキシ リクエスト |
mint.status |
文字列 | 読み取り専用 |
収益化された呼び出しのステータス。エラー時にのみ入力されます。 |
PostClientFlow |
mint.status_code |
数値 | 読み取り専用 |
収益化された呼び出しの HTTP ステータス コード。エラー時にのみ入力されます。 |
PostClientFlow |
mint.subscription_end_time_ms |
数値 | 読み取り専用 |
API プロダクト サブスクリプションの有効期限であるエポックからのミリ秒単位の経過時間。 このフロー変数は、MonetizationLimitsCheck ポリシーが API プロキシに接続されている場合に利用できます。API プロキシでの収益化の上限の適用をご覧ください。 |
プロキシ リクエスト |
mint.subscription_start_time_ms |
数値 | 読み取り専用 |
API プロダクト サブスクリプションが有効にされる時点であるエポックからのミリ秒単位の経過時間。 このフロー変数は、MonetizationLimitsCheck ポリシーが API プロキシに接続されている場合に利用できます。API プロキシでの収益化の上限の適用をご覧ください。 |
プロキシ リクエスト |
mint.tx_success_result |
ブール値 | 読み取り専用 |
トランザクションの収益化が成功したかどうかを示します。
|
PostClientFlow |
詳しくは以下をご覧ください。
organization
organization.name
プロパティのコンテナ。
次の表に、organization
変数のプロパティを示します。
プロパティ | 型 | 読み取りと書き込み | 説明 | スコープの開始 |
---|---|---|---|---|
organization.name |
文字列 | 読み取り専用 |
組織の名前。 |
プロキシ リクエスト |
組織の詳細については、組織についてをご覧ください。
proxy
API プロキシ構成。
次の表に、proxy
変数のプロパティを示します。
プロパティ | 型 | 読み取りと書き込み | 説明 | スコープの開始 |
---|---|---|---|---|
proxy.basepath |
文字列 | 読み取り専用 |
API プロキシ エンドポイントの構成に含まれる API プロキシのベースパス。ベースパスは、URL 内でホストの後に続く、左端の URI フラグメントです。条件付きフロー URI がベースパスに従います。 ベースパスが
|
プロキシ リクエスト |
proxy.client.ip |
文字列 | 読み取り専用 |
インバウンド呼び出しの |
プロキシ リクエスト |
proxy.name |
文字列 | 読み取り専用 |
ProxyEndpoint 用に構成された名前属性。 |
プロキシ リクエスト |
proxy.pathsuffix |
文字列 | 読み取り専用 |
クライアントから送信され、ProxyEndpoint で受信した URL のパス接尾辞の値。 ベースパスは左端のパス コンポーネントで、API プロキシを環境グループ内で一意に識別します。ベースパスが |
プロキシ リクエスト |
proxy.url |
文字列 | 読み取り専用 |
存在するすべてのクエリ パラメータを含む、ProxyEndpoint で受信したプロキシ リクエストに関連付けられている完全な URL を取得します。 |
プロキシ リクエスト |
API プロキシの処理の詳細については、API と API プロキシについてをご覧ください。
publishmessage
PublishMessage ポリシーの実行時に入力されます。
プロパティ | 型 | 読み取りと書き込み | 説明 | スコープの開始 |
---|---|---|---|---|
publishmessage.message.id | 文字列 | 読み取り専用 | Pub/Sub サーバーから messageId(パブリッシュされたメッセージの ID)を返します。 このフロー変数は、パブリッシュ リクエストが成功した場合にのみ Apigee によって設定されます。 |
プロキシ リクエスト |
ratelimit
Quota ポリシーまたは SpikeArrest ポリシーが実行されるときに入力されます。
次の表に、ratelimit
変数のプロパティを示します。
プロパティ | 型 | 読み取りと書き込み | 説明 | スコープの開始 |
---|---|---|---|---|
ratelimit.policy_name.allowed.count | Long 型 | 読み取り専用 | 許容される割り当て数を返します。 | PostClientFlow |
ratelimit.policy_name.used.count | Long 型 | 読み取り専用 | 割り当て間隔内で使用された現在の割り当てを返します。 | PostClientFlow |
ratelimit.policy_name.available.count | Long 型 | 読み取り専用 | 割り当て間隔で使用可能な割り当て数を返します。 | PostClientFlow |
ratelimit.policy_name.exceed.count | Long 型 | 読み取り専用 | 割り当てを超過していると、1 を返します。 | PostClientFlow |
ratelimit.policy_name.total.exceed.count | Long 型 | 読み取り専用 | 割り当てを超過していると、1 を返します。 | PostClientFlow |
ratelimit.policy_name.expiry.time | Long 型 | 読み取り専用 |
UTC 時間(ミリ秒)を返します。この時間が経過すると、割り当てが期限切れになり、新しい割り当て期間が開始されます。 Quota ポリシーのタイプが |
PostClientFlow |
ratelimit.policy_name.identifier | 文字列 | 読み取り専用 | ポリシーに追加された(クライアントの)ID 参照を返します。 | PostClientFlow |
ratelimit.policy_name.class | 文字列 | 読み取り専用 | クライアント ID に関連するクラスを返します。 | PostClientFlow |
ratelimit.policy_name.class.allowed.count | Long 型 | 読み取り専用 | クラスで定義された割り当ての許可数を返します。 | PostClientFlow |
ratelimit.policy_name.class.used.count | Long 型 | 読み取り専用 | クラスで使用された割り当てを返します。 | PostClientFlow |
ratelimit.policy_name.class.available.count | Long 型 | 読み取り専用 | クラスで使用可能な割り当て数を返します。 | PostClientFlow |
ratelimit.policy_name.class.exceed.count | Long 型 | 読み取り専用 | 現在の割り当て間隔でクラスの制限を超過したリクエストの数を返します。 | PostClientFlow |
ratelimit.policy_name.class.total.exceed.count | Long 型 | 読み取り専用 | すべての割り当て間隔でクラスの制限を超えるリクエストの合計数を返します。つまり、すべての割り当て間隔の class.exceed.count の合計になります。 |
PostClientFlow |
ratelimit.policy_name.failed | ブール値 | 読み取り専用 |
ポリシーが失敗したかどうかを表します(true または false)。 |
PostClientFlow |
詳しくは以下をご覧ください。
request
存在するすべてのペイロードを含む、完全なリクエスト。
リクエスト データの詳細については、リクエスト データをバックエンド サーバーに渡す方法をご覧ください。
次の表に、request
変数のプロパティを示します。
プロパティ | 型 | 読み取りと書き込み | 説明 | スコープの開始 |
---|---|---|---|---|
request |
message |
読み取り専用 |
存在するすべてのペイロードを含む、完全なリクエスト。 |
プロキシ リクエスト |
request.content |
文字列 | 読み取りと書き込み |
リクエスト メッセージのペイロードを取得または設定します。 |
プロキシ リクエスト |
request.formparam.param_name |
文字列 | 読み取りと書き込み |
クライアント アプリケーションから送信されたリクエストに含まれる、指定されたフォーム パラメータの値を取得または設定します。 |
プロキシ リクエスト |
request.formparam.param_name. |
コレクション | 読み取り専用 |
リクエストに含まれる特定のフォーム パラメータのすべての値(カンマ区切りリスト形式)。 たとえば、ペイロードが |
プロキシ リクエスト |
request.formparam.param_name. |
整数 | 読み取り専用 |
リクエストに関連付けられている、指定されたフォーム パラメータのすべての値の合計数。 |
プロキシ リクエスト |
request.formparam.param_name.N |
文字列 | 読み取りと書き込み |
メッセージ内の特定の N 番目のフォーム パラメータの値。たとえば、フォーム文字列が |
プロキシ リクエスト |
request.formparams.count |
整数 | 読み取り専用 |
クライアント アプリケーションから送信されたリクエストに関連付けられているすべてのパラメータの数です。 |
プロキシ リクエスト |
request.formparams.names |
コレクション | 読み取り専用 |
リクエストに関連付けられているすべてのパラメータ名のリスト。 |
プロキシ リクエスト |
request.formparams.names.string |
文字列 | 読み取り専用 |
リクエストに関連付けられているすべてのフォーム パラメータの名前のカンマ区切りリスト。 |
プロキシ リクエスト |
request.formstring |
文字列 | 読み取り専用 |
クライアント アプリから送信されたリクエストの完全な 例: |
プロキシ リクエスト |
request.grpc.rpc.name |
文字列 | 読み取り専用 |
gRPC ターゲット サーバーを使用する場合にのみ適用されます。RPC 名。gRPC プロキシの詳細については、gRPC API プロキシの作成をご覧ください。 |
プロキシ リクエスト |
request.grpc.service.name |
文字列 | 読み取り専用 |
gRPC ターゲット サーバーを使用する場合にのみ適用されます。gRPC ステータス サービス名。gRPC プロキシの詳細については、gRPC API プロキシの作成をご覧ください。 |
プロキシ リクエスト |
request.header.header_name |
文字列 | 読み取りと書き込み |
リクエストに含まれる特定のヘッダーの値を取得または設定します。ヘッダーにカンマが含まれている場合は、読み取り時に、最初のカンマまでのテキスト セグメントのみが返されます。 たとえば、 文字列としてヘッダー全体が必要な場合は、 |
プロキシ リクエスト |
request.header.header_name.N |
文字列 | 読み取りと書き込み |
リクエストに含まれる特定のヘッダーの N 番目の値。Apigee は、ヘッダーのテキスト値をコンマで区切ります。インデックスの左端の値は 1 から始まります。 たとえば、 |
プロキシ リクエスト |
request.header.header_name. |
コレクション | 読み取り専用 |
リクエストに含まれる特定のヘッダーのすべての値。 |
プロキシ リクエスト |
request.header.header_name. |
整数 | 読み取り専用 |
リクエストに含まれる特定のヘッダーのすべての値の合計数。 |
プロキシ リクエスト |
request.header.header_name. |
文字列 | 読み取り専用 |
リクエスト内の特定のヘッダーのすべての値(単一文字列形式)。 たとえば、 |
プロキシ リクエスト |
request.headers.count |
整数 | 読み取り専用 |
リクエストに含まれるすべてのヘッダーの合計数。 |
プロキシ リクエスト |
request.headers.names |
コレクション | 読み取り専用 |
リクエストに含まれるすべてのヘッダーの名前。 |
プロキシ リクエスト |
request.headers.names.string |
文字列 | 読み取り専用 |
リクエストに含まれるすべてのヘッダーの名前のカンマ区切りリスト。 |
プロキシ リクエスト |
request.path |
文字列 | 読み取り専用 |
バックエンド サービスへのプロキシを使用しないリソースパス(ホストを除く)。クエリ パラメータは除きます。 たとえば、バックエンド サービスへの URI が |
プロキシ リクエスト |
request.queryparam.param_name |
文字列 | 読み取りと書き込み |
リクエストで検出された特定のクエリ パラメータの値。 |
プロキシ リクエスト |
request.queryparam.param_name.N |
文字列 | 読み取りと書き込み |
リクエストに含まれる N 番目のクエリ パラメータの値。 たとえば、 たとえば、
|
プロキシ リクエスト |
request.queryparam.param_name. |
コレクション | 読み取り専用 |
リクエストに含まれる特定のクエリ パラメータのすべての値(カンマ区切りリスト形式)。 たとえば、 |
プロキシ リクエスト |
request.queryparam.param_name. |
整数 | 読み取り専用 |
リクエストに含まれる特定のクエリ パラメータのすべての値の合計数。 |
プロキシ リクエスト |
request.queryparams.count |
整数 | 読み取り専用 |
リクエストに含まれるすべてのクエリ パラメータの合計数。 |
プロキシ リクエスト |
request.queryparams.names |
コレクション | 読み取り専用 |
リクエストに含まれるすべてのクエリ パラメータの名前。 |
プロキシ リクエスト |
request.queryparams.names.string |
文字列 | 読み取り専用 |
リクエストに含まれるすべてのクエリ パラメータの名前のカンマ区切りリスト。 |
プロキシ リクエスト |
request.querystring |
文字列 | 読み取り専用 |
クライアント アプリから送信されたリクエストに含まれるクエリ パラメータの完全なリスト。 たとえば、リクエストが |
プロキシ リクエスト |
request.transportid |
文字列 | 読み取り専用 |
コンテキスト依存の TransportMessage 型のリクエストの ID。 |
プロキシ リクエスト |
request.transport.message |
TransportMessage | 読み取り専用 |
コンテキスト依存の TransportMessage 型のリクエスト。 |
プロキシ リクエスト |
request.uri |
文字列 | 読み取り専用 |
API プロキシでは、ProxyEndpoint のプロキシ
参照先
リクエストでは、 レスポンスでは、 この違いは、元のリクエストがプロキシに送信された後でプロキシがターゲット サービスに対して別のリクエストを行うために生じます。 次の呼び出しをサンプル プロキシに対して実行するとします。このサンプルのベースパスは
この後、プロキシは以下を呼び出します。
これにより、URL に
|
プロキシ リクエスト(レスポンスでは値が異なる) |
request.url |
文字列 | 読み取り専用 |
ターゲット エンドポイントに対して行われたリクエストの完全な URL。クエリ文字列パラメータを含みます。ポート番号は指定されていても含まれません。 たとえば、サンプル プロキシ
|
ターゲット レスポンス |
request.verb |
文字列 | 読み取り専用 |
リクエストに使用される HTTP 動詞。たとえば、 |
プロキシ リクエスト |
request.version |
文字列 | 読み取り専用 |
リクエストの HTTP バージョン。例: |
プロキシ リクエスト |
response
存在するすべてのペイロードを含む、完全なレスポンス。
次の表に、response
変数のプロパティを示します。
プロパティ | 型 | 読み取りと書き込み | 説明 | スコープの開始 |
---|---|---|---|---|
response |
message |
読み取りと書き込み |
ターゲットから返された完全なレスポンス メッセージ。 |
ターゲット レスポンス |
response.content |
文字列 | 読み取りと書き込み |
ターゲットから返されたレスポンス メッセージのペイロードの内容。 |
ターゲット レスポンス |
response.header.header_name |
文字列 | 読み取りと書き込み |
レスポンスに含まれる、指定された HTTP ヘッダーの値を取得または設定します。 ヘッダーのテキストにカンマが含まれている場合、Apigee は複数の値を推測します。この場合、 たとえば、 文字列としてヘッダー全体が必要な場合は、 |
ターゲット レスポンス |
response.header.header_name. |
コレクション | 読み取り専用 |
レスポンスに含まれる、指定された HTTP ヘッダーのすべての値。 |
ターゲット レスポンス |
response.header.header_name. |
整数 | 読み取り専用 |
レスポンスに含まれる、指定された HTTP ヘッダーのすべての値の合計数。 |
ターゲット レスポンス |
response.header.header_name. |
文字列 | 読み取り専用 |
レスポンス内の特定のヘッダーのすべての値(単一文字列形式)。 たとえば、 |
ターゲット レスポンス |
response.header.header_name.N |
文字列 | 読み取りと書き込み |
レスポンスに含まれる特定のヘッダーの N 番目の値。Apigee は、ヘッダーのテキスト値をコンマで区切ります。インデックスの左端の値は 1 から始まります。 たとえば、 |
ターゲット レスポンス |
response.headers.count |
整数 | 読み取り専用 |
レスポンスに含まれるすべてのヘッダーの合計数。 |
ターゲット レスポンス |
response.headers.names |
コレクション | 読み取り専用 |
レスポンスに含まれるすべてのヘッダーの名前。 |
ターゲット レスポンス |
response.headers.names.string |
文字列 | 読み取り専用 |
レスポンスに含まれるすべてのヘッダーの名前のカンマ区切りリスト。 |
ターゲット レスポンス |
response.reason.phrase |
文字列 | 読み取りと書き込み |
特定のリクエストに対するレスポンスの理由句。 |
ターゲット レスポンス |
response.status.code |
整数 | 読み取りと書き込み |
リクエストに対して返されるレスポンス コード。この変数を使用して、 |
ターゲット レスポンス |
response.transport.message |
文字列 | 読み取り専用 |
コンテキスト依存オブジェクトである TransportMessage 型のレスポンス。 |
ターゲット レスポンス |
route
<RouteRule>
と TargetEndpoint の名前を指定します。
次の表に、route
変数のプロパティを示します。
プロパティ | 型 | 読み取りと書き込み | 説明 | スコープの開始 |
---|---|---|---|---|
route.name |
文字列 | 読み取り専用 |
ProxyEndpoint で実行された |
ターゲット リクエスト |
route.target |
文字列 | 読み取り専用 |
実行された TargetEndpoint の名前。例: |
ターゲット リクエスト |
servicecallout
ServiceCallout ポリシーの TargetEndpoint を記述します。
次の表に、servicecallout
変数のプロパティを示します。
プロパティ | 型 | 読み取りと書き込み | 説明 | スコープの開始 |
---|---|---|---|---|
servicecallout.policy_name.expectedcn |
文字列 | 読み取りと書き込み |
ServiceCallout ポリシーで参照される TargetEndpoint で想定される共通名。これは、TargetEndpoint が TLS / SSL エンドポイントを参照している場合にのみ意味があります。 |
プロキシ リクエスト |
servicecallout.policy_name.target.url |
文字列 | 読み取りと書き込み |
特定の ServiceCallout ポリシーの TargetEndpoint URL。 |
プロキシ リクエスト |
servicecallout.requesturi |
文字列 | 読み取りと書き込み |
ServiceCallout ポリシーの TargetEndpoint URI。この URI は、プロトコルとドメイン仕様が指定されていない TargetEndpoint URL です。 |
プロキシ リクエスト |
system
システムの IP アドレスとプロキシに関する詳細を指定します。
次の表に、system
変数のプロパティを示します。
プロパティ | 型 | 読み取りと書き込み | 説明 | スコープの開始 |
---|---|---|---|---|
system.interface.interface_name |
文字列 | 読み取り専用 |
システムの IP アドレス。 |
プロキシ リクエスト |
system.pod.name |
文字列 | 読み取り専用 |
プロキシが稼働している Pod の名前。 |
プロキシ リクエスト |
system.region.name |
文字列 | 読み取り専用 |
プロキシが稼働しているデータセンターのリージョンの名前。 |
プロキシ リクエスト |
system.time |
文字列 | 読み取り専用 |
この変数が読み取られた時刻。例: Wed, 21 Aug 2013 19:16:47 GMT。 この値は、対応する |
プロキシ リクエスト |
system.time.year |
整数 | 読み取り専用 |
|
プロキシ リクエスト |
system.time.month |
整数 | 読み取り専用 |
|
プロキシ リクエスト |
system.time.day |
整数 | 読み取り専用 |
|
プロキシ リクエスト |
system.time.dayofweek |
整数 | 読み取り専用 |
|
プロキシ リクエスト |
system.time.hour |
整数 | 読み取り専用 |
|
プロキシ リクエスト |
system.time.minute |
整数 | 読み取り専用 |
|
プロキシ リクエスト |
system.time.second |
整数 | 読み取り専用 |
|
プロキシ リクエスト |
system.time.millisecond |
整数 | 読み取り専用 |
|
プロキシ リクエスト |
system.time.zone |
文字列 | 読み取り専用 |
システムのタイムゾーン。 |
プロキシ リクエスト |
system.timestamp |
Long 型 | 読み取り専用 |
この変数が読み取られた時刻を表す 64 ビット(long 型)の整数。値は、世界標準時 1970 年 1 月 1 日午前 0 時からの経過時間(ミリ秒数)です。たとえば、 |
プロキシ リクエスト |
system.uuid |
文字列 | 読み取り専用 |
プロキシを処理する Message Processor の UUID。 |
プロキシ リクエスト |
target
リクエストのターゲットに関する情報を提供します。
次の表に、target
変数のプロパティを示します。
プロパティ | 型 | 読み取りと書き込み | 説明 | スコープの開始 |
---|---|---|---|---|
target.basepath |
文字列 | 読み取り専用 |
クエリ パラメータを除く、ターゲット サービスへのリソースパス(ドメインは含まれません)。このリソースパスは、プロキシの TargetEndpoint で定義されているものです。 たとえば、API プロキシが次のターゲットを呼び出すとします。
この例では、 今度は、ターゲットが次のようになっているとします。
この場合、 |
ターゲット リクエスト |
target.copy.pathsuffix |
ブール値 | 読み取りと書き込み |
|
ターゲット リクエスト |
target.copy.queryparams |
ブール値 | 読み取りと書き込み |
|
ターゲット リクエスト |
target.country |
文字列 | 読み取り専用 |
ターゲット サーバーから提示された TLS / SSL 証明書に示されている国。 |
ターゲット レスポンス |
target.cn |
文字列 | 読み取り専用 |
TargetEndpoint の共通名。これは、TargetEndpoint が TLS / SSL エンドポイントを参照している場合にのみ意味があります。 |
ターゲット リクエスト |
target.email.address |
文字列 | 読み取り専用 |
ターゲット サーバーから提示された TLS / SSL 証明書に示されているメールアドレス。 |
ターゲット レスポンス |
target.expectedcn |
文字列 | 読み取りと書き込み |
TargetEndpoint で想定される共通名。これは、TargetEndpoint が TLS / SSL エンドポイントを参照している場合にのみ意味があります。 |
プロキシ リクエスト |
target.host |
文字列 | 読み取り専用 |
API プロキシにレスポンスを返しているターゲット サービスのドメイン名。 |
ターゲット レスポンス |
target.ip |
文字列 | 読み取り専用 |
API プロキシにレスポンスを返しているターゲット サービスの IP アドレス。 |
ターゲット レスポンス |
target.locality |
文字列 | 読み取り専用 |
ターゲット サーバーから提示された TLS / SSL 証明書に示されている地域(市区町村)。 |
ターゲット レスポンス |
target.name |
文字列 | 読み取り専用 |
TargetEndpoint からのメッセージが到達するターゲット。 |
ターゲット リクエスト |
target.organization |
文字列 | 読み取り専用 |
ターゲット サーバーから提示された TLS / SSL 証明書に示されている組織。 |
ターゲット レスポンス |
target.organization.unit |
文字列 | 読み取り専用 |
ターゲット サーバーから提示された TLS / SSL 証明書に示されている組織単位。 |
ターゲット レスポンス |
target.port |
整数 | 読み取り専用 |
API プロキシにレスポンスを返しているターゲット サービスのポート番号。 |
ターゲット レスポンス |
target.received.end.time |
文字列 | 読み取り専用 |
TargetEndpoint がターゲットからのレスポンス受信を完了した時刻。文字列形式で表記されます。例: Wed, 21 Aug 2013 19:16:47 UTC。 この時刻値は、対応する 32 ビット タイムスタンプの数値の文字列表現です。たとえば、「Wed, 21 Aug 2013 19:16:47 UTC」はタイムスタンプ値 1377112607413 に相当します。 |
ターゲット レスポンス |
target.received.end. |
Long 型 | 読み取り専用 |
TargetEndpoint がターゲットからのレスポンス受信を完了した時刻を示すタイムスタンプ値。例: |
ターゲット レスポンス |
target.received.start.time |
文字列 | 読み取り専用 |
TargetEndpoint がターゲットからのレスポンス受信を開始した時刻。文字列形式で表記されます。例: Wed, 21 Aug 2013 19:16:47 UTC。 この時刻値は、対応する 32 ビット タイムスタンプの数値の文字列表現です。たとえば、「Wed, 21 Aug 2013 19:16:47 UTC」はタイムスタンプ値 1377112607413 に相当します。 |
ターゲット レスポンス |
target.received.start. |
Long 型 | 読み取り専用 |
TargetEndpoint がターゲットからレスポンス受信を開始した時刻を示すタイムスタンプ値。例: |
ターゲット レスポンス |
target.scheme |
文字列 | 読み取り専用 |
スコープの開始: ターゲット レスポンス リクエスト メッセージに応じて、http または https を返します。 |
ターゲット リクエスト |
target.sent.end.time |
文字列 | 読み取り専用 |
プロキシが TargetEndpoint で指定された URL へのリクエスト送信を停止した時刻。文字列形式で表記されます。例: Wed, 21 Aug 2013 19:16:47 UTC。 この時刻値は、対応する 32 ビット タイムスタンプの数値の文字列表現です。たとえば、「Wed, 21 Aug 2013 19:16:47 UTC」はタイムスタンプ値 1377112607413 に相当します。 |
ターゲット リクエスト |
target.sent.end.timestamp |
Long 型 | 読み取り専用 |
プロキシが TargetEndpoint で指定された URL へのリクエスト送信を完了した時刻を示すタイムスタンプ値。例: 1377112607413。この値は、1970 年 1 月 1 日午前 0 時(UTC)からの経過時間(ミリ秒数)を含む 64 ビット(long 型)の整数です。 |
ターゲット リクエスト |
target.sent.start.time |
文字列 | 読み取り専用 |
プロキシが TargetEndpoint で指定された URL へのリクエスト送信を開始した時刻。文字列形式で表記されます。例: Wed, 21 Aug 2013 19:16:47 UTC。 この時刻値は、対応する 32 ビット タイムスタンプの数値の文字列表現です。たとえば、「Wed, 21 Aug 2013 19:16:47 UTC」はタイムスタンプ値 1377112607413 に相当します。 |
ターゲット リクエスト |
target.sent.start.timestamp |
Long 型 | 読み取り専用 |
プロキシが TargetEndpoint で指定された URL へのリクエスト送信を開始した時刻を示すタイムスタンプ値。例: |
ターゲット リクエスト |
target.ssl.enabled |
ブール値 | 読み取り専用 |
TargetEndpoint が TLS / SSL で実行されているかどうか。 |
プロキシ リクエスト |
target.state |
文字列 | 読み取り専用 |
ターゲット サーバーから提示された TLS / SSL 証明書に示されている状態。 |
ターゲット レスポンス |
target.url |
文字列 | 読み取りと書き込み |
TargetEndpoint XML ファイルで構成された URL または動的ターゲット URL(メッセージ フロー中に |
ターゲット リクエスト |
variable
variable.expectedcn
プロパティのコンテナ。
次の表に、variable
変数のプロパティを示します。
プロパティ | 型 | 読み取りと書き込み | 説明 | スコープの開始 |
---|---|---|---|---|
variable.expectedcn |
文字列 | 読み取りと書き込み |
TLS / SSL で実行される場合に共通名として公開される変数。 |
プロキシ リクエスト |
TLS の操作の詳細については、TLS の構成オプションをご覧ください。