流程變數參考資料

本頁內容適用於 Apigee 和 Apigee Hybrid。

查看 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 產品作業的名稱。這個變數可協助您區分配額政策設定和 API 產品作業的配額設定。

例如 my-operation。

 Proxy 要求
apiproduct.operation.resource 字串 唯讀

與要求相符的作業資源名稱。

 Proxy 要求
apiproduct.operation.methods 陣列 唯讀

作業允許的 HTTP 方法陣列。

 Proxy 要求
apiproduct.operation.attributes.key_name 陣列 唯讀

取得與 key_name 相符的自訂屬性值。

 Proxy 要求

如要瞭解詳情，請參考下列資源：

apiproxy

說明 API Proxy。

下表說明 apiproxy 變數的屬性：

屬性 類型 讀取/寫入 說明 範圍開始
apiproxy.name 字串 唯讀 API Proxy 的名稱。例如 My Proxy。 Proxy 要求
apiproxy.revision 字串 唯讀 API Proxy 的修訂版本號碼。例如 6。 Proxy 要求
apiproxy.basepath 字串 唯讀 部署基本路徑 (在 API 部署期間指定)。 Proxy 要求

如要進一步瞭解如何使用 API Proxy，請參閱「瞭解 API 和 API Proxy」。

client

將要求傳送至負載平衡器的應用程式或系統。

下表說明 client 變數的屬性：

屬性 類型 讀取/寫入 說明 範圍開始
client.cn 字串 唯讀

用戶端應用程式提供的 TLS/SSL 憑證中指定的一般名稱。

 Proxy 要求
client.country 字串 唯讀

用戶端應用程式提供的 TLS/SSL 憑證中的國家/地區。

 Proxy 要求
client.email.address 字串 唯讀

用戶端應用程式提供的 TLS/SSL 憑證中的電子郵件地址。

 Proxy 要求
client.host 字串 唯讀

ProxyEndpoint 收到的要求相關聯的 HTTP 主機 IP。

 Proxy 要求
client.ip 字串 唯讀

將訊息傳送至負載平衡器的用戶端或系統 IP 位址。例如原始用戶端 IP 或負載平衡器 IP。

 Proxy 要求
client.locality 字串 唯讀

用戶端提供的 TLS/SSL 憑證中的所在地 (城市)。

 Proxy 要求
client.organization 字串 唯讀 用戶端提供的 TLS/SSL 憑證中的機構。(不一定等同於 Apigee 上的機構。) Proxy 要求
client.organization.unit 字串 唯讀

用戶端提供的 TLS/SSL 憑證中的機構單位。

 Proxy 要求
client.port 整數 唯讀

與傳送至 ProxyEndpoint 的原始用戶端要求相關聯的 HTTP 通訊埠。

 Proxy 要求
client.received.end.time 字串 唯讀

Proxy 在 ProxyEndpoint 接收來自原始用戶端的要求時，以字串形式表示的時間。例如：Wed, 21 Aug 2013 19:16:47 UTC。

這個時間值是相應 32 位元時間戳記量的字串表示法。舉例來說，2013 年 8 月 21 日星期三 19:16:47 UTC 對應的時間戳記值為 1377112607413。

 Proxy 要求
client.received.end.timestamp 長 唯讀

時間戳記值，指定 Proxy 在 ProxyEndpoint 接收來自原始用戶端的要求時。這個值是 64 位元 (長) 整數，內含自世界標準時間 1970 年 1 月 1 日午夜起經過的毫秒數。

 Proxy 要求
client.received.start.time 字串 唯讀

Proxy 開始在 ProxyEndpoint 接收來自原始用戶端的要求時，以字串形式表示的時間。例如：Wed, 21 Aug 2013 19:16:47 UTC

這個時間值是相應 32 位元時間戳記量的字串表示法。舉例來說，2013 年 8 月 21 日星期三 19:16:47 UTC 對應的時間戳記值為 1377112607413。

 Proxy 要求
client.received.start.timestamp 長 唯讀

時間戳記值，指定 Proxy 開始從 ProxyEndpoint 的原始用戶端接收要求的時間。這個值是 64 位元 (長) 整數，內含自世界標準時間 1970 年 1 月 1 日午夜起經過的毫秒數。

 Proxy 要求
client.resolved.ip 字串 唯讀

已解析的用戶端 IP 位址。如果未指定用戶端 IP 解析設定，則這是從已設定的用戶端 IP 解析設定或預設演算法判斷出的值。詳情請參閱「用戶端 IP 位址解析」。

 Proxy 要求
client.scheme 字串 唯讀

視用戶端應用程式用來傳送要求訊息的傳輸方式而定，傳回 HTTP 或 HTTPS。

 Proxy 要求
client.sent.end.time 字串 唯讀

以字串形式表示的時間，指出 Proxy 從 ProxyEndpoint 傳送回應至用戶端的時間。例如：Wed, 21 Aug 2013 19:16:47 UTC。

這個值是相應 32 位元 client.sent.end.timestamp 的字串表示法。舉例來說，Wed, 21 Aug 2013 19:16:47 UTC 對應的時間戳記值為 1377112607413。

 PostClientFlow
client.sent.end.timestamp 長 唯讀 時間戳記值，指定 ProxyEndpoint 何時完成將回應傳回給原始用戶端應用程式。這個值是 64 位元 (長) 整數，包含自世界標準時間 1970 年 1 月 1 日午夜起經過的毫秒數。 PostClientFlow
client.sent.start.time 字串 唯讀 ProxyEndpoint 開始將回應傳回原始用戶端應用程式的時間，以字串形式表示。例如：Wed, 21 Aug 2013 19:16:47 UTC。

這個值是相應 32 位元 client.sent.start.timestamp 的字串表示法。舉例來說，Wed, 21 Aug 2013 19:16:47 UTC 對應的時間戳記值為 1377112607413。

 PostClientFlow
client.sent.start.timestamp 長 唯讀 Proxy 開始從 ProxyEndpoint 將回應傳送給用戶端的時間。這個值以 64 位元 (長) 整數表示，內含自世界標準時間 1970 年 1 月 1 日午夜起經過的毫秒數。 PostClientFlow
client.ssl.enabled 字串 唯讀

true 如果 ProxyEndpoint 已設定 TLS/SSL，否則為 false。

 Proxy 要求
client.state 字串 唯讀

用戶端提供的 TLS/SSL 憑證中的州/省。

 Proxy 要求

current

內含目前 API Proxy 流程的相關資訊。

下表說明 current 變數的屬性：

屬性 類型 讀取/寫入 說明 範圍開始
current.flow.name 字串 唯讀 目前執行的流程名稱 (例如 PreFlow、PostFlow 或條件流程的名稱)。 Proxy 要求
current.flow.description 字串 唯讀 目前執行中流程的說明。這與流程 XML 設定中 <Description> 元素的值相同。 Proxy 要求

您可以在 Apigee UI 的「追蹤」檢視畫面中查看這些屬性。

environment

environment.name 屬性的容器。

下表說明 environment 變數的屬性：

屬性 類型 讀取/寫入 說明 範圍開始
environment.name 字串 唯讀 執行交易的環境名稱。 Proxy 要求

error

代表錯誤流程中錯誤訊息的脈絡物件。

下表說明 error 變數的屬性：

屬性 類型 讀取/寫入 說明 範圍開始
error message 讀取/寫入 message 類型的錯誤，這是錯誤流程中的內容物件。 錯誤
error.content 字串 讀取/寫入 錯誤內容。 錯誤
error.message 字串 唯讀

與錯誤相關的訊息，只有在執行錯誤流程前才能取得值。

 錯誤
error.status.code 整數 唯讀

與錯誤相關聯的 HTTP 狀態碼。例如 400。

 錯誤
error.transport.message TransportMessage 唯讀

任何 TransportMessage 類型的錯誤。

 錯誤
error.state 整數 唯讀

發生錯誤的流程狀態。

 錯誤
error.header.header_name 字串 讀取/寫入

取得或設定回應標頭。

 錯誤

fault

提供有關執行階段錯誤來源、原因和詳細資料的資訊。當政策擲回錯誤時，Apigee 會設定這些變數，且值會因政策而異。如要瞭解 fault 變數的設定時機，請參閱「 關於政策錯誤」。

屬性 類型 讀取/寫入 說明 範圍開始
fault.name 字串 唯讀 錯誤名稱，如每個政策參考主題中包含的「執行階段錯誤」表格所述。這個變數可能適用於套用至 FaultRule 的條件。 錯誤
fault.reason 字串 唯讀 故障原因。舉例來說，當 OASValidation 政策偵測到傳入要求未通過 OpenAPI 規格驗證時，就會將這個變數設為字串，說明政策名稱、規格名稱，以及要求未通過規格驗證的原因。其他政策會將這個變數設為適合其錯誤的訊息。 錯誤
fault.category 字串 唯讀 類別。舉例來說，如果政策步驟發生錯誤，這個變數可能會保留「Step」值。這個變數可能適用於套用至 FaultRule 的條件。 錯誤
fault.subcategory 字串 唯讀 子類別。舉例來說，如果 OASValidation 政策偵測到要求未通過 OpenAPI 規格驗證，就會將這個變數設為「OASValidationFailure」。這個變數可能適用於套用至 FaultRule 的條件。 錯誤

graphql

讓您在執行階段存取 GraphQL 查詢結果。詳情請參閱「GraphQL 政策」。

下表說明 graphql 變數的屬性：

屬性 類型 讀取/寫入 說明
graphql 複雜型別 唯讀/讀寫 根 GraphQL 查詢。 SCOPE
graphql.fragment 複雜型別 唯讀/讀寫 這項查詢的預設片段參照。 SCOPE
graphql.fragment.count 整數 唯讀 這個 GraphQL 查詢產生的片段數量。 SCOPE
graphql.fragment.INDEX.selectionSet.INDEX 類型 唯讀/讀寫 指定索引處的選取項目集參照。 SCOPE
graphql.fragment.INDEX.selectionSet.INDEX.name 字串 唯讀/讀寫 指定索引處的選取項目集名稱。 SCOPE
graphql.fragment.INDEX.selectionSet.count 整數 唯讀 這個片段中的選取項目集數量。 SCOPE
graphql.fragment.INDEX.selectionSet.name 字串 唯讀/讀寫 片段中預設選取項目的名稱。 SCOPE
graphql.operation 複雜型別 唯讀/讀寫 查詢預設作業的參照。

您無法在作業層級設定配額。請改為在環境層級設定。

 SCOPE
graphql.operation.name 字串 唯讀 查詢預設作業的名稱。 SCOPE
graphql.operation.operationType Enumeration 唯讀 可對這個 API Proxy 執行的查詢預設作業類型。可能的值為 query、mutation 或 all。 SCOPE
graphql.operation.selectionSet 複雜型別 查詢預設作業的預設選取項目集。 SCOPE
graphql.operation.selectionSet.count 整數 唯讀 查詢預設作業中的選取集數量。 SCOPE
graphql.operation.selectionSet.name 字串 唯讀 查詢預設作業的預設選取項目集名稱。 SCOPE
graphql.operation.selectionSet.INDEX 整數 唯讀 選取集參照，位於選取集清單中指定索引處。 SCOPE
graphql.operation.selectionSet.INDEX.name 字串 唯讀 此作業的選取項目組合清單中，指定索引處的選取項目名稱。 SCOPE
graphql.operation.selectionSet.INDEX.[selectionSet] 複雜型別 唯讀/讀寫 一或多個額外的選取項目集物件。

選取集可以遞迴存取。舉例來說，在 selectionSet.index 之後，您可以擁有另一個 selectionSet.index，而不是 name 屬性。依此類推，直到達到您在 GraphQL 政策中設定的 <MaxCount> 值為止。

SCOPE
graphql.operation.selectionSet.INDEX.directive 複雜型別 指定選取項目集中的預設指令參照。 SCOPE
graphql.operation.selectionSet.INDEX.directive.count 複雜型別 SCOPE
graphql.operation.selectionSet.INDEX.directive.INDEX 整數 唯讀 指定索引處的指令參照。 SCOPE
graphql.operation.selectionSet.INDEX.directive.INDEX.argument.INDEX 整數 唯讀 指定索引處的引數參照。 SCOPE
graphql.operation.selectionSet.INDEX.directive.INDEX.argument.INDEX.name 字串 指定索引處的引數名稱。 SCOPE
graphql.operation.selectionSet.INDEX.directive.INDEX.argument.INDEX.value 字串 指定索引處的引數值。 SCOPE
graphql.operation.selectionSet.INDEX.directive.name 字串 SCOPE
graphql.operation.variableDefinitions 複雜型別 查詢預設作業的變數定義清單參照。 SCOPE
graphql.operation.variableDefinitions.count 整數 查詢預設作業的變數定義數量。 SCOPE
graphql.operation.variableDefinitions.INDEX 整數 指定索引處的變數定義參照。 SCOPE
graphql.operation.variableDefinitions.INDEX.name 字串 指定索引處的變數定義名稱。 SCOPE
graphql.operation.variableDefinitions.INDEX.type 指定索引處的變數定義值類型。 SCOPE

is

is.error 屬性的容器。

下表說明 is 變數的屬性：

屬性 類型 讀取/寫入 說明 範圍開始
is.error 布林值 唯讀

錯誤旗標。

 Proxy 要求

loadbalancing

提供 TargetEndpoint 的負載平衡狀態相關資訊。

下表說明 loadbalancing 變數的屬性：

屬性 類型 讀取/寫入 說明 範圍開始
loadbalancing.failedservers 字串陣列 唯讀

在 TargetEndpoint 進行負載平衡時，失敗的 TargetServer 清單。

 目標回覆
loadbalancing.isfallback 布林值 唯讀

true 如果在 TargetEndpoint 的負載平衡期間叫用 TargetServer 時，已啟用備援功能。

 目標回覆
loadbalancing.targetserver 字串 唯讀

在 TargetEndpoint 負載平衡期間叫用的 TargetServer。只有在定義負載平衡器元素時設定了 <Path> 元素，才需要設定此屬性。

 目標回覆

message

內容物件，其值與要求流程中的 request 相同，或與回應流程中的 response 相同，或與錯誤流程中的 error 相同。

下表說明 message 變數的屬性：

屬性 類型 讀取/寫入 說明 範圍開始
message message 讀取/寫入

內容物件，其值與要求流程中的 request、回應流程中的 response 或錯誤流程中的 error 相同。

 Proxy 要求
message.content 字串 讀取/寫入

要求、回應或錯誤訊息的內容。

 Proxy 要求
message.content.as.base64 字串 唯讀

要求、回應或錯誤訊息的 Base64 編碼酬載內容。

 Proxy 要求
message.content.as.url.safe.base64 字串 唯讀

要求、回應或錯誤訊息的網址安全 Base64 編碼酬載內容。

 Proxy 要求
message.formparam.param_name 字串 讀取/寫入

指定表單參數的值。

 Proxy 要求
message.formparam.param_name.
 values		 集合 唯讀

訊息中指定表單參數的所有值。

 Proxy 要求
message.formparam.param_name.
 values.count		 整數 唯讀

訊息中指定表單參數的值數量。

 Proxy 要求
message.formparams.count 整數 唯讀

郵件中所有表單參數的計數。

 Proxy 要求
message.formparams.names 集合 唯讀

訊息中所有表單參數的值。

 Proxy 要求
message.formparams.names.string 字串 唯讀

以半形逗號分隔的郵件中所有表單參數名稱清單。

 Proxy 要求
message.formstring 字串 唯讀

郵件中表單字串的值。

 Proxy 要求
message.header.header_name 字串 讀取/寫入

取得或設定要求中特定標頭的值。如果標題包含半形逗號，系統只會讀取第一個半形逗號前的文字。

舉例來說，如果 Cache-control 標頭為 public, maxage=16544，則 message.header.cache-control 的傳回值為 public。

如要將整個標頭當做字串，請使用 message.header.header_name.values.string 等變數。

 Proxy 要求
message.header.header_name.N 字串 讀取/寫入

訊息中第 N 個特定標頭的值，視流程狀態而定，可能是要求或回應。Apigee 會以半形逗號分隔標頭文字值。最左邊的值索引為 1。

舉例來說，如果 Cache-control 標頭為 public,maxage=16544，則 message.header.cache-control.2 的傳回值為 maxage=16544。

 Proxy 要求
message.header.header_name.
 values		 集合 唯讀

訊息中指定 HTTP 標頭名稱的所有值。

 Proxy 要求
message.header.header_name.
 values.count		 整數 唯讀

郵件中指定 HTTP 標頭名稱的值數量。

 Proxy 要求
message.header.header_name.
 values.string		 字串 唯讀

郵件中特定標頭的所有值，以單一字串的形式呈現。

舉例來說，如果 Cache-control 標頭為 public,maxage=16544，則 message.header.cache-control.values.string 的傳回值為 public,maxage=16544。

 Proxy 要求
message.headers.count 整數 唯讀

郵件中所有 HTTP 標頭的計數。

 Proxy 要求
message.headers.names 集合 唯讀

郵件中所有 HTTP 標頭的值。

 Proxy 要求
message.headers.names.string 字串 唯讀

以半形逗號分隔的郵件中所有標頭名稱清單。

 Proxy 要求
message.path 字串 讀取/寫入

網址中完整的要求訊息路徑，不含任何查詢參數。

 Proxy 要求
message.queryparam.param_name 字串 唯讀

傳回指定的訊息查詢參數。

 Proxy 要求
message.queryparam.param_name.N 字串 讀取/寫入

訊息中第 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
 Proxy 要求
message.queryparam.param_name.
 values		 集合 唯讀

訊息中特定查詢參數的所有值，格式為以半形逗號分隔的清單。

舉例來說，如果查詢字串為 a=hello&a=world，則 message.queryparam.a.values 的值為 ['hello', 'world']code>。

 Proxy 要求
message.queryparam.param_name.
 values.count		 整數 唯讀

與從用戶端應用程式傳送至 ProxyEndpoint 的要求相關聯的指定查詢參數總數。

 Proxy 要求
message.queryparams.count 整數 唯讀

與從用戶端應用程式傳送至 ProxyEndpoint 的要求相關聯的所有查詢參數總數。

 Proxy 要求
message.queryparams.names 集合 唯讀

與從用戶端應用程式傳送至 ProxyEndpoint 的要求相關聯的所有查詢參數名稱清單。

 Proxy 要求
message.queryparams.names.string 字串 唯讀

以半形逗號分隔的郵件中所有查詢參數名稱清單。

 Proxy 要求
message.querystring 字串 唯讀

這個字串包含與從用戶端應用程式傳送至 ProxyEndpoint 的要求相關聯的所有查詢參數名稱和值。

舉例來說，如果是 http://api.apifactory.com/inventors?name=nick&surname=danger 要求，message.querystring 的值為 name=nick&surname=danger。

 Proxy 要求
message.status.code 整數 唯讀

目標傳回的回應訊息 HTTP 狀態碼。

 目標回覆
message.transport.message TransportMessage 唯讀

TransportMessage 類型的訊息，這是內容物件。

 Proxy 要求
message.uri 字串 唯讀

完整 URI 路徑 (網域網址後方)，包括查詢參數。

舉例來說，如果要求是 http://api.apifactory.com/inventors?name=nikola&surname=tesla，這個變數會傳回 inventors?name=nikola&surname=tesla。

 Proxy 要求
message.verb 字串 唯讀

與要求相關聯的 HTTP 動詞 (GET、PUT、POST、DELETE 等)。

 Proxy 要求
message.version 字串 讀取/寫入

與從用戶端應用程式傳送至 ProxyEndpoint 的要求相關聯的 HTTP 版本。

 Proxy 要求

如要進一步瞭解訊息，請參閱訊息範本函式參考資料。

messageid

要求的全域專屬 ID 的容器。

下表說明 messageid 變數的屬性：

屬性 類型 讀取/寫入 說明 範圍開始
messageid 字串 唯讀

保留要求的全域專屬 ID，包括負載平衡器主機名稱。 這個 ID 可用於追蹤負載平衡器收到的要求，這些要求會傳送至訊息處理器。

Apigee 錯誤記錄檔會記錄這個 ID，以便將 messageid 與錯誤相互關聯。

 Proxy 要求

mint

提供營利資訊的輔助變數。

下表說明 mint 變數的屬性：

屬性 類型 讀取/寫入 說明 範圍開始
mint.limitscheck.is_request_blocked 布林值 唯讀

此標記會指定是否封鎖 API 要求。如果 is_subscription_found 為 false，請設為 true。

如果 MonetizationLimitsCheck 政策附加至 API 代理項目，即可使用這個流程變數。請參閱 MonetizationLimitsChecks Flow 變數。

 Proxy 要求
mint.limitscheck.is_subscription_found 布林值 唯讀

此標記用於指定開發人員是否已有效訂閱 API 產品。如果開發人員有訂閱項目，請設為 true。

如果 MonetizationLimitsCheck 政策附加至 API 代理項目，即可使用這個流程變數。請參閱 MonetizationLimitsChecks Flow 變數。

 Proxy 要求
mint.limitscheck.prepaid_developer_balance 數字 唯讀

開發人員預付帳戶錢包的目前餘額，與費率方案的幣別相關聯。

 Proxy 要求
mint.limitscheck.prepaid_developer_currency 字串 唯讀

mint.limitscheck.prepaid_developer_balance 變數中可用餘額的幣別。

 Proxy 要求
mint.limitscheck.purchased_product_name 字串 唯讀

相關聯的 API 產品名稱。

如果 MonetizationLimitsCheck 政策附加至 API 代理項目，即可使用這個流程變數。請參閱 MonetizationLimitsChecks Flow 變數。

 Proxy 要求
mint.limitscheck.status_message 字串 唯讀

為進行偵錯，提供有關執行 MonetizationLimitsCheck 政策的其他資訊。

如果 MonetizationLimitsCheck 政策附加至 API 代理項目，即可使用這個流程變數。請參閱 MonetizationLimitsChecks Flow 變數。

 Proxy 要求
mint.mintng_consumption_pricing_rates 字串 唯讀

根據用量計費。

建立費率方案時，請設定費用。

 PostClientFlow
mint.mintng_consumption_pricing_type 字串 唯讀

根據用量計費的定價類型。例如：FIXED_PER_UNIT

建立費率方案時，請設定以用量計費的費用。

 PostClientFlow
mint.mintng_currency 字串 唯讀

計算收益時使用的幣別。

這個流程變數的值為currency 營利變數。

 DataCapture 政策
mint.mintng_dev_share 數字 唯讀

與開發人員分享的收益。

建立費率方案時，設定要與開發人員分享的收益。

 PostClientFlow
mint.mintng_is_apiproduct_monetized 布林值 唯讀

這個旗標會指定 API 產品目前是否營利 (也就是是否有生效中的有效費率方案)。

這個流程變數是由附加至 API Proxy 的 VerifyAPIKey 或 VerifyAccessToken 政策新增。請參閱新增驗證策略。

 Proxy 要求
mint.mintng_price 數字 唯讀

用於計算開發人員分潤的收益。

流程變數的值為 revShareGrossPrice monetization 變數。

 DataCapture 政策和 PostClientFlow
mint.mintng_price_multiplier 數字 唯讀

每筆交易費用要乘上的係數 (乘數)。

流程變數的值為 perUnitPriceMultiplier monetization 變數。

 DataCapture 政策和 PostClientFlow
mint.mintng_rate 數字 唯讀

API 呼叫的收費費率。

這個流程變數會顯示每次 API 呼叫的用量計費費用。 建立費率方案時，請設定以用量計費的費用。 如果您已在 DataCapture 政策中設定perUnitPriceMultiplier 營利變數，Apigee 會考量 perUnitPriceMultiplier 變數的值，計算交易費用。詳情請參閱「指標」中的 Api price multiplier。

 PostClientFlow
mint.mintng_rate_before_multipliers 數字 唯讀

API 呼叫的收費費率，不含 perUnitPriceMultiplier 計算。

如果 DataCapture 政策擷取 perUnitPriceMultiplier 營利變數，這個流程變數會顯示交易費用，然後將費用乘以 perUnitPriceMultiplier。

 PostClientFlow
mint.mintng_rate_plan_id 字串 唯讀

房價方案的 ID。

這個流程變數是由附加至 API Proxy 的 VerifyAPIKey 或 VerifyAccessToken 政策新增。請參閱新增驗證策略。

 Proxy 要求
mint.mintng_revenue_share_rates 字串 唯讀

收益分潤費率。

建立費率方案時，設定收益分潤成數。

 PostClientFlow
mint.mintng_revenue_share_type 字串 唯讀

收益分潤類型。例如：FIXED

建立費率方案時，請設定收益分潤類型。

 PostClientFlow
mint.mintng_tx_success 布林值 唯讀

指定交易是否營利。

這個流程變數的值為transactionSuccess 營利變數。

 DataCapture 政策
mint.prepaid_updated_developer_usage 數字 唯讀

預付開發人員目前的用量。

系統會根據費率方案設定和 perUnitPriceMultiplier 營利變數的值計算用量。

 PostClientFlow
mint.rateplan_end_time_ms 數字 唯讀

費率方案的到期時間，以 Epoch 紀元時間後毫秒為單位。

這個流程變數是由附加至 API Proxy 的 VerifyAPIKey 或 VerifyAccessToken 政策新增。請參閱新增驗證策略。

 Proxy 要求
mint.rateplan_start_time_ms 數字 唯讀

費率方案的啟用時間，以 Epoch 紀元時間起算的毫秒數表示。

這個流程變數是由附加至 API Proxy 的 VerifyAPIKey 或 VerifyAccessToken 政策新增。請參閱新增驗證策略。

 Proxy 要求
mint.status 字串 唯讀

營利電話的狀態。僅在發生錯誤時填入。

 PostClientFlow
mint.status_code 數字 唯讀

營利通話的 HTTP 狀態碼。僅在發生錯誤時填入。

 PostClientFlow
mint.subscription_end_time_ms 數字 唯讀

API 產品訂閱項目的到期時間，以自 Epoch 紀元時間起的毫秒為單位。

如果 MonetizationLimitsCheck 政策附加至 API 代理項目，即可使用這個流程變數。請參閱 MonetizationLimitsChecks Flow 變數。

 Proxy 要求
mint.subscription_start_time_ms 數字 唯讀

API 產品訂閱的啟用時間，以自訓練週期開始計算的毫秒數表示。

如果 MonetizationLimitsCheck 政策附加至 API 代理項目，即可使用這個流程變數。請參閱 MonetizationLimitsChecks Flow 變數。

 Proxy 要求
mint.tx_success_result 布林值 唯讀

指出交易是否成功營利。

mint.tx_success_result 變數可具有下列值：

  • tx_success 設為 true：transactionSuccess 變數為 true，且交易已營利。由於交易已營利，系統會計算 mint.mintng_rate 和 mint.mintng_dev_share 變數的值。
  • tx_success 設為 false：transactionSuccess 變數為 false，且交易未營利。由於交易未營利，因此系統不會計算 mint.mintng_rate 和 mint.mintng_dev_share 變數的值。
  • 找不到 tx_success。訊息狀態碼不是 2xx：系統未擷取 transactionSuccess 變數，且交易的 HTTP 狀態碼 (message.status.code) 不是 2xx。交易無法營利。
  • 找不到 tx_success。訊息狀態碼為 2xx：系統不會擷取 transactionSuccess 變數，且交易的 HTTP 狀態碼 (message.status.code) 為 2xx。交易已啟用營利功能。
 PostClientFlow

如要瞭解詳情，請參考下列資源：

organization

organization.name 屬性的容器。

下表說明 organization 變數的屬性：

屬性 類型 讀取/寫入 說明 範圍開始
organization.name 字串 唯讀

機構名稱。

 Proxy 要求

如要進一步瞭解機構，請參閱「瞭解機構」。

proxy

API Proxy 設定。

下表說明 proxy 變數的屬性：

屬性 類型 讀取/寫入 說明 範圍開始
proxy.basepath 字串 唯讀

API Proxy 端點設定中的「Base Path」(基本路徑) 值。基本路徑是網址中主機之後最左側的 URI 片段。條件式流程 URI 會遵循基本路徑。

假設您已設定 API Proxy 端點，且基本路徑為 /v2/weatherapi。(詳情請參閱「Proxy 端點設定」。) 在這種情況下，如果傳入要求使用網址 https://myhost.example.net/v2/weatherapi/forecastrss?w=12797282，則：

  • 主機名稱為 myhost.example.net。您可以讀取 request.header.host 變數來擷取這項資訊。
  • 基本路徑為 /v2/weatherapi。方法是讀取 proxy.basepath 變數。
  • 路徑後置字串為 /forecastrss。方法是讀取 proxy.pathsuffix 變數。

如果您在 API Proxy 設定中定義動態基本路徑，例如 /v2/*/weatherapicode>，則 proxy.basepath 變數會設為動態路徑。如要擷取要求的實際網址，請讀取並剖析 proxy.url 變數。

 Proxy 要求
proxy.client.ip 字串 唯讀

傳入呼叫的 X-Forwarded-For 位址，也就是 Apigee 從最後一次外部 TCP 交握收到的 IP 位址。這可能是呼叫端用戶端或負載平衡器。

 Proxy 要求
proxy.name 字串 唯讀

為 ProxyEndpoint 設定的名稱屬性。

 Proxy 要求
proxy.pathsuffix 字串 唯讀

從用戶端傳送並在 ProxyEndpoint 接收的網址路徑後置字串值。

Basepath 是最左側的路徑元件，用於在環境群組中唯一識別 API Proxy。假設您已設定 API Proxy 端點，且基本路徑為 /v2/weatherapi。在這種情況下，傳送至 https://myhost.example.net/v2/weatherapi/forecastrss?w=12797282 的要求會讓 proxy.pathsuffix 變數保留字串 /forecastrss。

 Proxy 要求
proxy.url 字串 唯讀

取得與 ProxyEndpoint 收到的 Proxy 要求相關聯的完整網址，包括任何查詢參數。

 Proxy 要求

如要進一步瞭解如何使用 API Proxy，請參閱「瞭解 API 和 API Proxy」。

publishmessage

在執行 PublishMessage 政策時填入。

屬性 類型 讀取/寫入 說明 範圍開始
publishmessage.message.id 字串 唯讀 從 Pub/Sub 伺服器傳回 messageId (已發布訊息的 ID)。

只有在發布要求成功時，Apigee 才會設定這個流程變數。

 Proxy 要求

ratelimit

配額或 SpikeArrest 政策執行時會填入這個值。

下表說明 ratelimit 變數的屬性：

屬性 類型 讀取/寫入 說明 範圍開始
ratelimit.policy_name.allowed.count 長 唯讀 傳回允許的配額數量。 PostClientFlow
ratelimit.policy_name.used.count 長 唯讀 傳回配額間隔內目前使用的配額。 PostClientFlow
ratelimit.policy_name.available.count 長 唯讀 傳回配額間隔內的可用配額數。 PostClientFlow
ratelimit.policy_name.exceed.count 長 唯讀 超過配額時，傳回 1。 PostClientFlow
ratelimit.policy_name.total.exceed.count 長 唯讀 超過配額時，傳回 1。 PostClientFlow
ratelimit.policy_name.expiry.time 長 唯讀

傳回 UTC 時間 (以毫秒為單位)，用於判斷配額到期時間和新配額間隔的開始時間。

如果配額政策的類型為 rollingwindow，這個值無效，因為配額間隔永不過期。

 PostClientFlow
ratelimit.policy_name.identifier 字串 唯讀 傳回附加至政策的 (用戶端) 參照 ID PostClientFlow
ratelimit.policy_name.class 字串 唯讀 傳回與用戶端 ID 相關聯的類別 PostClientFlow
ratelimit.policy_name.class.allowed.count 長 唯讀 傳回類別中定義的允許配額數 PostClientFlow
ratelimit.policy_name.class.used.count 長 唯讀 傳回類別中已使用的配額 PostClientFlow
ratelimit.policy_name.class.available.count 長 唯讀 傳回類別中的可用配額數 PostClientFlow
ratelimit.policy_name.class.exceed.count 長 唯讀 傳回目前配額間隔內，類別中超出限制的要求數 PostClientFlow
ratelimit.policy_name.class.total.exceed.count 長 唯讀 傳回所有配額間隔中，超過類別限制的要求總數，因此是所有配額間隔的 class.exceed.count 總和。 PostClientFlow
ratelimit.policy_name.failed 布林值 唯讀

指出政策是否失敗 (true 或 false)。

 PostClientFlow

如要瞭解詳情，請參考下列資源：

request

完整要求，包括任何酬載。

如要進一步瞭解要求資料，請參閱「要求資料如何傳遞至後端伺服器？」一文。

下表說明 request 變數的屬性：

屬性 類型 讀取/寫入 說明 範圍開始
request message 唯讀

完整要求，包括任何酬載。

 Proxy 要求
request.content 字串 讀取/寫入

取得或設定要求訊息的酬載。

 Proxy 要求
request.content.as.base64 字串 唯讀

要求訊息的 Base64 編碼酬載內容。

 Proxy 要求
request.content.as.url.safe.base64 字串 唯讀

要求訊息的酬載內容 (採用網址安全 Base64 編碼)。

 Proxy 要求
request.formparam.param_name 字串 讀取/寫入

取得或設定從用戶端應用程式傳送的要求中，指定表單參數的值。

 Proxy 要求
request.formparam.param_name.
 values		 集合 唯讀

要求中特定表單參數的所有值，格式為以逗號分隔的清單。

舉例來說，如果酬載為 a=hello&x=greeting&a=world，則 request.formparam.a.values 的值為 ['hello', 'world']。

 Proxy 要求
request.formparam.param_name.
 values.count		 整數 唯讀

與要求相關聯的指定表單參數的所有值計數。

 Proxy 要求
request.formparam.param_name.N 字串 讀取/寫入

訊息中第 N 個特定表單參數的值。舉例來說，如果格式字串為 a=hello&a=world，則 request.formparam.a.1 的傳回值為 hello。

 Proxy 要求
request.formparams.count 整數 唯讀

與從用戶端應用程式傳送的要求相關聯的所有參數計數。

 Proxy 要求
request.formparams.names 集合 唯讀

與要求相關聯的所有參數名稱清單。

 Proxy 要求
request.formparams.names.string 字串 唯讀

以半形逗號分隔的清單，列出與要求相關聯的所有表單參數名稱。

 Proxy 要求
request.formstring 字串 唯讀

用戶端應用程式傳送要求中的完整 formparam。

例如 name=test&type=first&group=A。

 Proxy 要求
request.grpc.rpc.name 字串 唯讀

僅適用於使用 gRPC 目標伺服器時。RPC 名稱。如要瞭解 gRPC Proxy，請參閱「建立 gRPC API Proxy」。

 Proxy 要求
request.grpc.service.name 字串 唯讀

僅適用於使用 gRPC 目標伺服器時。gRPC 狀態服務名稱。如要瞭解 gRPC Proxy，請參閱「建立 gRPC API Proxy」。

 Proxy 要求
request.header.header_name 字串 讀取/寫入

取得或設定要求中特定標頭的值。如果標題包含半形逗號，系統只會讀取第一個半形逗號前的文字。

舉例來說，如果 Cache-control 標頭為 public, maxage=16544，則 request.header.cache-control 的傳回值為 public。

如要將整個標頭當做字串，請使用 request.header.header_name.values.string 等變數。

 Proxy 要求
request.header.header_name.N 字串 讀取/寫入

要求中第 N 個特定標頭值。Apigee 會以半形逗號分隔標頭文字值。最左邊的值索引為 1。

舉例來說，如果 Cache-control 標頭為 public, maxage=16544，則 request.header.cache-control.2 的傳回值為 maxage=16544。

 Proxy 要求
request.header.header_name.
 values		 集合 唯讀

要求中特定標頭的所有值。

 Proxy 要求
request.header.header_name.
 values.count		 整數 唯讀

要求中特定標頭的所有值數量。

 Proxy 要求
request.header.header_name.
 values.string		 字串 唯讀

要求中特定標頭的所有值，以單一字串的形式呈現。

舉例來說，如果 Cache-control 標頭為 public, maxage=16544，則 request.header.cache-control.values.string 的傳回值為 public, maxage=16544。

 Proxy 要求
request.headers.count 整數 唯讀

要求中所有標頭的計數。

 Proxy 要求
request.headers.names 集合 唯讀

要求中所有標頭的名稱。

 Proxy 要求
request.headers.names.string 字串 唯讀

以半形逗號分隔的清單，列出要求中的所有標頭名稱。

 Proxy 要求
request.path 字串 唯讀

後端服務的未經 Proxy 處理的資源路徑 (不含主機)，不含查詢參數。

舉例來說，如果後端服務的 URI 是 https://example.com/rest/api/latest，則 request.path 的值為 /rest/api/latest。

 Proxy 要求
request.queryparam.param_name 字串 讀取/寫入

要求中特定查詢參數的值。

 Proxy 要求
request.queryparam.param_name.N 字串 讀取/寫入

要求中的 Nth 查詢參數值。

舉例來說，如果 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
 Proxy 要求
request.queryparam.param_name.
 values		 集合 唯讀

要求中特定查詢參數的所有值，格式為以逗號分隔的清單。

舉例來說，如果 request.querystring 是 a=hello&b=lovely&a=world，則 request.queryparam.a.values 的值為 ['hello', 'world']。

 Proxy 要求
request.queryparam.param_name.
 values.count		 整數 唯讀

要求中特定查詢參數的所有值數量。

 Proxy 要求
request.queryparams.count 整數 唯讀

要求中所有查詢參數的計數。

 Proxy 要求
request.queryparams.names 集合 唯讀

要求中所有查詢參數的名稱。

 Proxy 要求
request.queryparams.names.string 字串 唯讀

以半形逗號分隔的要求中所有查詢參數名稱清單。

 Proxy 要求
request.querystring 字串 唯讀

從用戶端應用程式傳送的要求中，查詢參數的完整清單。

舉例來說，如果要求是 http://host.com/123?name=first&surname=second&place=address，這個變數就會傳回 name=first&surname=second&place=address。

 Proxy 要求
request.transportid 字串 唯讀

要求 ID，類型為 TransportMessage，屬於情境式。

 Proxy 要求
request.transport.message Transport-Message 唯讀

屬於情境式 TransportMessage 類型的要求。

 Proxy 要求
request.uri 字串 唯讀

在 API Proxy 中，ProxyEndpoint 中的 Proxy <BasePath> (以及 Proxy 的基準網址) 會對應至 TargetEndpoint 中的目標服務網址。例如：

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

指向

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

在要求中，request.uri 是 Proxy 基礎路徑 + 位址的其餘部分，包括查詢參數。

在回應中，request.uri 是 HTTPTargetConnection 後的地址餘數，包括查詢參數。

這是因為原始要求傳入 Proxy 後，Proxy 又向目標服務發出另一項要求。

假設對範例 Proxy 進行下列呼叫，該 Proxy 的基本路徑為 /my-mock-proxy：

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

Proxy 會呼叫：

http://mocktarget.apigee.net

這會將 /user?user=Dude 附加至該網址。

  • 要求：request.uri = /my-mock-proxy/user?user=Dude
  • 回應：request.uri = /user?user=Dude
 Proxy 要求 (回應不同)
request.url 字串 唯讀

向目標端點提出的要求完整網址，包括查詢字串參數，但不包括連接埠號碼 (如有指定)。

舉例來說，如果您呼叫範例 Proxy http://my_org-test.apigee.net/my-mock-proxy/user?user=Dude，且目標端點為 http://example.com:8080，則值為：

  • 要求：不適用
  • 回覆：http://example.com/user?user=Dude
 目標回覆
request.verb 字串 唯讀

要求使用的 HTTP 動詞。例如 GET、PUT 和 DELETE。

 Proxy 要求
request.version 字串 唯讀

要求的 HTTP 版本。例如 1.1。

 Proxy 要求

response

完整的回應，包括任何酬載。

下表說明 response 變數的屬性：

屬性 類型 讀取/寫入 說明 範圍開始
response message 讀取/寫入

目標傳回的完整回應訊息。

 目標回覆
response.content 字串 讀取/寫入

目標傳回的回應訊息酬載內容。

 目標回覆
response.content.as.base64 字串 唯讀

回應訊息的 Base64 編碼酬載內容。

 目標回覆
response.content.as.url.safe.base64 字串 唯讀

回應訊息的酬載內容 (採用網址安全 Base64 編碼)。

 目標回覆
response.event.current.content 字串 讀取/寫入

EventFlow 串流回應中傳回的內容。詳情請參閱「以串流方式傳送伺服器傳送的事件」。

 EventFlow 回應
response.event.current.count 整數 讀取

逐步計算傳送的回應事件數。系統會針對收到的每個事件更新這個值。 詳情請參閱「以串流方式傳送伺服器傳送的事件」。

。 		EventFlow 回應
response.header.header_name 字串 讀取/寫入

取得或設定回應中指定 HTTP 標頭的值。

如果標頭文字包含半形逗號，Apigee 會推斷出多個值。在本例中，response.header.header_name 只會傳回第一個值。

舉例來說，如果 Cache-control 標頭為 public,maxage=16544，則 response.header.cache-control 的傳回值為 public。

如要將整個標頭當做字串，請使用 response.header.header_name.values.string 等變數。

 目標回覆
response.header.header_name.
 values		 集合 唯讀

回應中指定 HTTP 標頭的所有值。

 目標回覆
response.header.header_name.
 values.count		 整數 唯讀

回應中指定 HTTP 標頭的所有值數量。

 目標回覆
response.header.header_name.
 values.string		 字串 唯讀

回應中特定標頭的所有值，以單一字串的形式呈現。

舉例來說，如果 Cache-control 標頭為 public,maxage=16544，則 response.header.cache-control.values.string 的傳回值為 public,maxage=16544。

 目標回覆
response.header.header_name.N 字串 讀取/寫入

回應中第 N 個特定標頭的值。Apigee 會以半形逗號分隔標頭文字值。最左邊的值索引為 1。

舉例來說，如果 Cache-control 標頭為 public,maxage=16544，則 response.header.cache-control.2 會傳回 maxage=16544。

 目標回覆
response.headers.count 整數 唯讀

回應中所有標頭的計數。

 目標回覆
response.headers.names 集合 唯讀

回應中所有標頭的名稱。

 目標回覆
response.headers.names.string 字串 唯讀

以半形逗號分隔的回應中所有標頭的名稱清單。

 目標回覆
response.status.code 整數 讀取/寫入

要求傳回的回應代碼。您可以使用這個變數覆寫儲存在 message.status.code 中的回應狀態碼。詳情請參閱 message。

 目標回覆
response.transport.message 字串 唯讀

TransportMessage 類型的回應，這是情境物件。

 目標回覆

route

指定 <RouteRule> 和 TargetEndpoint 的名稱。

下表說明 route 變數的屬性：

屬性 類型 讀取/寫入 說明 範圍開始
route.name 字串 唯讀

在 ProxyEndpoint 中執行的 <RouteRule> 名稱。例如：default。RouteRule 會參照要執行的 API Proxy TargetEndpoint。

 目標要求
route.target 字串 唯讀

執行的 TargetEndpoint 名稱。例如 default。

 目標要求

servicecallout

說明 ServiceCallout 政策的 TargetEndpoint。

下表說明 servicecallout 變數的屬性：

屬性 類型 讀取/寫入 說明 範圍開始
servicecallout.policy_name.expectedcn 字串 讀取/寫入

TargetEndpoint 的預期通用名稱，如ServiceCallout 政策中所述。只有在 TargetEndpoint 參照 TLS/SSL 端點時，這才有意義。

 Proxy 要求
servicecallout.policy_name.target.url 字串 讀取/寫入

特定 ServiceCallout 政策的 TargetEndpoint 網址。

 Proxy 要求
servicecallout.requesturi 字串 讀取/寫入

ServiceCallout 政策的 TargetEndpoint URI。URI 是 TargetEndpoint 網址，但不含通訊協定和網域規格。

 Proxy 要求

system

指定系統的 IP 位址，以及 Proxy 的詳細資料。

下表說明 system 變數的屬性：

屬性 類型 讀取/寫入 說明 範圍開始
system.interface.interface_name 字串 唯讀

系統的 IP 位址。

 Proxy 要求
system.pod.name 字串 唯讀

執行 Proxy 的 Pod 名稱。

 Proxy 要求
system.region.name 字串 唯讀

執行 Proxy 的資料中心 區域名稱。

 Proxy 要求
system.time 字串 唯讀

讀取這個變數的時間。例如 Wed, 21 Aug 2013 19:16:47 GMT。

這個值是 system.timestamp 對應值的字串表示法。舉例來說，2013 年 8 月 21 日星期三 19:16:47 GMT 對應的時間戳記值為 1377112607413。

 Proxy 要求
system.time.year 整數 唯讀

system.time 的年份部分。

 Proxy 要求
system.time.month 整數 唯讀

system.time 的月份部分。

 Proxy 要求
system.time.day 整數 唯讀

system.time 的當月第幾日部分。

 Proxy 要求
system.time.dayofweek 整數 唯讀

system.time 的星期幾部分。

 Proxy 要求
system.time.hour 整數 唯讀

system.time 的小時部分。

 Proxy 要求
system.time.minute 整數 唯讀

system.time 的分鐘部分。

 Proxy 要求
system.time.second 整數 唯讀

system.time 的第二個部分。

 Proxy 要求
system.time.millisecond 整數 唯讀

system.time 的毫秒部分。

 Proxy 要求
system.time.zone 字串 唯讀

系統時區。

 Proxy 要求
system.timestamp 長 唯讀

代表讀取這個變數時間的 64 位元 (長) 整數。這個值是自世界標準時間 1970 年 1 月 1 日午夜起經過的毫秒數。例如：1534783015000。

 Proxy 要求
system.uuid 字串 唯讀

處理 Proxy 的訊息處理器 UUID。

 Proxy 要求

target

說明要求目標。

下表說明 target 變數的屬性：

屬性 類型 讀取/寫入 說明 範圍開始
target.basepath 字串 唯讀

目標服務的資源路徑 (不含網域)，不包括查詢參數，定義於 Proxy 的 TargetEndpoint 中。

舉例來說，假設 API Proxy 呼叫下列目標：

<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 會是空值。

 目標要求
target.copy.pathsuffix 布林值 讀取/寫入

當 true 時，從 ProxyEndpoint 轉送至 TargetEndpoint 的要求會保留路徑尾碼 (URI 路徑片段，位於 ProxyEndpoint 基準路徑中定義的 URI 後方)。

 目標要求
target.copy.queryparams 布林值 讀取/寫入

當 true 為 true 時，從 ProxyEndpoint 轉送至 TargetEndpoint 的要求會保留查詢參數。

 目標要求
target.country 字串 唯讀

目標伺服器提供的 TLS/SSL 憑證國家/地區

 目標回覆
target.cn 字串 唯讀

TargetEndpoint 的一般名稱。只有在 TargetEndpoint 參照 TLS/SSL 端點時，這個屬性才有意義。

 目標要求
target.email.address 字串 唯讀

目標伺服器提供的 TLS/SSL 憑證電子郵件地址

 目標回覆
target.expectedcn 字串 讀取/寫入

TargetEndpoint 的預期一般名稱。只有在 TargetEndpoint 參照 TLS/SSL 端點時，這個屬性才有意義。

 Proxy 要求
target.header.host 字串 讀取/寫入

Apigee 用於為傳送至目標的要求設定 Host 標頭值的流程變數。如果目標網址或目標伺服器使用 IP 位址 (例如以 PSC 端點為基礎的目標)，可用於將值設為主機名稱。

 目標要求
target.host 字串 唯讀

目標服務的網域名稱，會將回應傳回 API Proxy。

 目標回覆
target.ip 字串 唯讀

目標服務的 IP 位址，會將回應傳回 API Proxy。

 目標回覆
target.locality 字串 唯讀

目標伺服器提供的 TLS/SSL 憑證所在地 (城市)

 目標回覆
target.name 字串 唯讀

訊息從目標端點傳送至的目標。

 目標要求
target.organization 字串 唯讀

目標伺服器提供的 TLS/SSL 憑證機構。

 目標回覆
target.organization.unit 字串 唯讀

目標伺服器提供的 TLS/SSL 憑證所屬的機構單位。

 目標回覆
target.port 整數 唯讀

目標服務的通訊埠號碼，會將回應傳回 API Proxy。

 目標回覆
target.received.end.time 字串 唯讀

目標端點完成接收目標回應的時間，以字串形式表示。例如：Wed, 21 Aug 2013 19:16:47 UTC。

這個時間值是相應 32 位元時間戳記量的字串表示法。舉例來說，2013 年 8 月 21 日星期三 19:16:47 UTC 對應的時間戳記值為 1377112607413。

 目標回覆
target.received.end.
  timestamp		 長 唯讀

時間戳記值，指定 TargetEndpoint 何時完成接收來自目標的回應。例如，1534783015000。這個值是 64 位元 (長) 整數，指定自世界標準時間 1970 年 1 月 1 日午夜起經過的毫秒數。

 目標回覆
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.
  timestamp		 長 唯讀

時間戳記值，指定 TargetEndpoint 開始接收目標回應的時間。例如，1534783015000。這個值是 64 位元 (長) 整數，指定自世界標準時間 1970 年 1 月 1 日午夜起經過的毫秒數。

 目標回覆
target.scheme 字串 唯讀

範圍開始：目標回應
類型：字串
權限：讀取/寫入

視要求訊息而定，傳回 http 或 https。

 目標要求
target.sent.end.time 字串 唯讀

以字串形式表示的時間，Proxy 會在這個時間停止將要求傳送至 TargetEndpoint 中指定的網址。例如：Wed, 21 Aug 2013 19:16:47 UTC。

這個時間值是相應 32 位元時間戳記量的字串表示法。舉例來說，Wed, 21 Aug 2013 19:16:47 UTC 對應的時間戳記值為 1377112607413。

 目標要求
target.sent.end.timestamp 長 唯讀

時間戳記值，指定 Proxy 何時完成將要求傳送至 TargetEndpoint 中指定的網址。例如 1377112607413。這個值是 64 位元 (長) 整數，內含自世界標準時間 1970 年 1 月 1 日午夜起經過的毫秒數。

 目標要求
target.sent.start.time 字串 唯讀

Proxy 開始將要求傳送至 TargetEndpoint 中指定網址的時間 (以字串形式表示)。例如：Wed, 21 Aug 2013 19:16:47 UTC。

這個時間值是相應 32 位元時間戳記量的字串表示法。舉例來說，Wed, 21 Aug 2013 19:16:47 UTC 對應的時間戳記值為 1377112607413。

 目標要求
target.sent.start.timestamp 長 唯讀

時間戳記值，指定 Proxy 開始將要求傳送至 TargetEndpoint 中指定網址的時間。例如，1534783015000。這個值是 64 位元 (長) 整數，指定自世界標準時間 1970 年 1 月 1 日午夜起經過的毫秒數。

 目標要求
target.ssl.enabled 布林值 唯讀

TargetEndpoint 是否在 TLS/SSL 上執行。

 Proxy 要求
target.state 字串 唯讀

目標伺服器提供的 TLS/SSL 憑證狀態。

 目標回覆
target.url 字串 讀取/寫入

TargetEndpoint XML 檔案中設定的網址，或動態目標網址 (如果訊息流程中已設定 target.url)。變數不包含任何其他路徑元素或查詢參數。如果呼叫超出範圍，或未設定其他值，則傳回空值。

 目標要求

variable

variable.expectedcn 屬性的容器。

下表說明 variable 變數的屬性：

屬性 類型 讀取/寫入 說明 範圍開始
variable.expectedcn 字串 讀取/寫入

如果是在 TLS/SSL 上執行，則會公開通用名稱的變數。

 Proxy 要求

如要進一步瞭解如何使用 TLS，請參閱「傳輸層安全標準 (TLS) 設定選項」。