JavaScript 物件模型

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

查看 Apigee Edge 說明文件。

本主題將說明 Apigee JavaScript 物件模型。如果您打算使用 JavaScript 政策，將自訂 JavaScript 新增至 API 代理，請務必瞭解這個模型。

關於 JavaScript 物件模型

JavaScript 物件模型會定義物件和相關聯的屬性，這些屬性可供在 Apigee 代理流程中執行的 JavaScript 程式碼使用。使用 JavaScript 政策，將這段自訂程式碼附加至 API Proxy 流程。

這個模型定義的物件在 API Proxy 流程中具有範圍，也就是說，只有在流程中的特定時間點，才能使用特定物件和屬性。執行 JavaScript 時，系統會為執行作業建立範圍。在該範圍內，系統會建立下列物件參照：

• context：可存取訊息內容的物件
• 要求：可存取要求物件的簡寫
• response：可存取回應物件的簡寫
• crypto：提供各種雜湊函式
• print：用於發出輸出內容的函式
• 屬性：允許讀取政策的設定屬性

背景資訊物件

context 物件具有全域範圍。您可以在 API Proxy 流程中的任何位置使用。包含四個子物件：proxyRequest、proxyResponse、targetRequest 和 targetResponse。這些子物件的範圍限定於環境要求和回應，也就是 Proxy 要求和回應，或是目標要求和回應。舉例來說，如果 JavaScript 政策在流程的 Proxy 端點部分執行，則 context.proxyRequest 和 context.proxyResponse 物件會位於範圍內。如果 JavaScript 在目標流程中執行，則 context.targetRequest 和 context.targetResponse 物件會位於範圍內。

context 物件也有屬性和方法，本主題會詳細說明。舉例來說，下列 JavaScript 程式碼範例會使用 context.flow 屬性，並在 context 上呼叫 get/setVariable() 方法。

if (context.flow=="PROXY_REQ_FLOW") {
     var username = context.getVariable("request.formparam.user");
     context.setVariable("USER.name", username);
}

這些方法會直接與流程變數互動。context.flow 屬性值是目前的流程範圍。在 Proxy 要求流程中，這個值會設為常數 PROXY_REQ_FLOW。如果目標回應流程設為 TARGET_RESP_FLOW，這個常數有助於執行範圍專屬的程式碼。getter 可讓您取得流程變數，setter 則可讓您設定流程變數。這些變數通常可在 Proxy 流程中使用，並供其他政策取用。

詳情和範例請參閱內容物件參考資料。

加密物件

crypto 物件會在 JavaScript 物件模型中新增基本的高效能加密支援功能。詳情和範例請參閱 crypto 物件參考資料。

要求和回應物件

request 和 response 物件是環境要求和回應的簡寫參照，可以是 Proxy 要求和回應，也可以是目標要求和回應。這些變數參照的物件取決於 JavaScript 政策的執行環境。如果 JavaScript 在 Proxy 端點的流程中執行，則要求和回應變數會參照 context.proxyRequest 和 context.proxyResponse。如果 JavaScript 在目標流程中執行，則變數會參照 context.targetRequest 和 context.targetResponse。

print() 函式

JavaScript 物件模型包含 print() 函式，可用於將偵錯資訊輸出至 Apigee Debug 工具。請參閱「使用 JavaScript print() 陳述式進行偵錯」。

屬性物件

在政策設定中使用 Properties 元素時，JavaScript 程式碼可使用 properties 變數存取這些屬性的值。

舉例來說，如果您的 JavaScript 設定包含：

<Javascript name='JS-1' >
  <Properties>
    <Property name="number">8675309</Property>
    <Property name="firstname">Jenny</Property>
  </Properties>
  <ResourceURL>jsc://my-code.js</ResourceURL>
</Javascript>

接著，您可以在 my-code.js 中執行下列操作：

  print(properties.firstname);  // prints Jenny
  print(properties.number);  // 8675309

更實際地說，設定可讓程式碼在不同環境、不同時間或任何原因下執行時，呈現不同行為。

舉例來說，下列程式碼指定了「變數名稱」，以及 JavaScript 應將資訊發布至的輸出樣式：

<Javascript name='JS-2' >
  <Properties>
    <Property name="output">my_output_variable</Property>
    <Property name="prettyPrint">true</Property>
  </Properties>
  <ResourceURL>jsc://emit-results.js</ResourceURL>
</Javascript>

接著，在 emit-results.js 中，程式碼可以執行下列操作：

var result = { prop1: "something", prop2 : "something else" } ;
if (properties.prettyPrint == "true") {
  context.setVariable(properties.output, JSON.stringify(result, null, 2));
}
else {
  context.setVariable(properties.output, JSON.stringify(result));
}

加密物件參考資料

您可以使用 crypto 物件，在 JavaScript 中執行基本的加密雜湊函式。

注意：加密函式僅支援雜湊，不支援雙向加密。

這個加密物件具有全域範圍。您可以在 API Proxy 流程中的任何位置使用這項功能。 您可以使用 Crypto 處理下列雜湊物件：

• SHA-1
• SHA256
• SHA512
• MD5

提示：Apigee 建議您使用 crypto 物件，在 Apigee 上執行的 JavaScript 程式中執行基本加密功能。

使用 SHA-1 物件

您可以建立 SHA-1 物件、更新物件，以及將物件轉換為十六進位和 Base64 值。

建立新的 SHA-1 物件

var _sha1 = crypto.getSHA1();

更新 SHA-1 物件

語法

_sha1.update(value);

參數

• value - (字串) 任何字串值。

範例

更新 SHA-1 物件：

_sha1.update("salt_value");

_sha1.update("some text");

以十六進位字串形式傳回 SHA-1 物件

var _hashed_token = _sha1.digest();

以 Base64 字串形式傳回 SHA-1 物件

var _hashed_token = _sha1.digest64();

使用 SHA-256 物件

您可以建立 SHA-256 物件、更新物件，以及將物件轉換為十六進位和 Base64 值。

建立新的 SHA-256 物件

var _sha256 = crypto.getSHA256();

更新 SHA-256 物件

語法

_sha256.update(value);

參數

• value - (字串) 任何字串值。

範例

更新 SHA-256 物件：

_sha256.update("salt_value");

_sha256.update("some text");

以十六進位字串形式傳回 SHA-256 物件

var _hashed_token = _sha256.digest();

以 base64 字串形式傳回 SHA-256 物件

var _hashed_token = _sha256.digest64();

使用 SHA-512 物件

您可以建立 SHA-512 物件、更新物件，以及將物件轉換為十六進位和 Base64 值。

建立新的 SHA-512 物件

var _sha512 = crypto.getSHA512();

更新 SHA-512 物件

語法

_sha512.update(value);

參數

• value - (字串) 任何字串值。

範例

更新 SHA-512 物件：

_sha512.update("salt_value");

_sha512.update("some text");

以十六進位字串形式傳回 SHA-512 物件

var _hashed_token = _sha512.digest();

以 Base64 字串形式傳回 SHA-512 物件

var _hashed_token = _sha512.digest64();

使用 MD5 物件

您可以建立 MD5 物件、更新物件，以及將物件轉換為十六進位和 base64 值。

建立新的 MD5 物件

var _md5 = crypto.getMD5();

更新 MD5 物件

語法

_md5.update(value);

參數

• value - (字串) 任何字串值。

範例

更新 MD5 物件：

_md5.update("salt_value");

_md5.update("some text");

以十六進位字串形式傳回 MD5 物件

var _hashed_token = _md5.digest();

以 Base64 字串形式傳回 MD5 物件

var _hashed_token = _md5.digest64();

支援加密編譯日期/時間

crypto 物件支援日期/時間格式化模式。

crypto.dateFormat()

以字串格式傳回日期。

語法

crypto.dateFormat(format, [timezone], [time])

參數

• format - (String) 這個參數的基礎實作項目為 java.text.SimpleDateFormat。例如：'YYYY-MM-DD HH:mm:ss.SSS'
• timezone - (字串，選用) 這個參數的基礎實作項目為 java.util.TimeZone。 這個參數與預設值相同：世界標準時間
• time - (數字，選用) 要設定格式的 Unix 時間戳記值。預設： 目前時間

範例

注意：java.text.SimpleDateFormat 說明文件提供所有日期/時間格式字元和字元組合的完整清單，以及詳細範例。

取得目前時間 (精確到毫秒)：

var _now = crypto.dateFormat('YYYY-MM-DD HH:mm:ss.SSS');

取得太平洋時區的目前時間：

var _pst = crypto.dateFormat('YYYY-MM-DD HH:mm:ss.SSS','PST');

取得十秒後的值：

var _timeNow = Number(context.getVariable('system.timestamp'));
var tenSeconds = crypto.dateFormat('YYYY-MM-DD HH:mm:ss.SSS','PST', _timeNow + 10 * 1000);

其他範例。另請參閱 java.text.SimpleDateFormat 說明文件。

var _pst = crypto.dateFormat('M');

var _pst = crypto.dateFormat('EEE, d MMM yyyy HH:mm:ss Z');

var _pst = crypto.dateFormat("yyyy-MM-dd'T'HH:mm:ss.SSSZ");

使用 getHash() 取得任何支援的雜湊物件

範例

var _hash1 = crypto.getHash('MD5');

var _hash2 = crypto.getHash('SHA-1');

var _hash3 = crypto.getHash('SHA-256');

var _hash4 = crypto.getHash('SHA-512');

加密貨幣範例

try {
    // get values to use with hash functions
    var salt = context.getVariable("salt") || 'SomeHardCodedSalt';
    var host = context.getVariable("request.header.Host");
    var unhashedToken = "";

    var _timeNow = Number(context.getVariable('system.timestamp'));
    var now = crypto.dateFormat('YYYY-MM-DD HH:mm:ss.SSS','PST', _timeNow);
    unhashed_token = "|" + now + "|" + host

    // generate a hash with the unhashedToken:
    var sha512 = crypto.getSHA512();
    sha512.update(salt);
    sha512.update(unhashedToken);

    // convert to base64
    var base64Token = sha512.digest64();

    // set headers
    context.setVariable("request.header.now", now);
    context.setVariable("request.header.token", base64Token);

} catch(e) {
    throw 'Error in Javascript';
}

背景資訊物件參考

• 內容物件摘要
• context 物件方法
• 背景資訊物件屬性
• 背景資訊物件子項

API Proxy 執行的每筆要求/回應交易都會建立 context 物件。context 物件會公開方法，用來取得、設定及移除與每筆交易相關的變數。

變數會定義交易專屬的屬性，要求用戶端的時區、要求用戶端的語言代碼、要求用戶端的 User-Agent，以及目標服務的網址，都是 context 中可用的變數範例。因此，context 可用於建構依賴這些屬性的邏輯，以執行自訂行為。

請參閱流程變數參考資料和 ExtractVariables 政策。

背景資訊 物件摘要

下表簡要說明內容物件及其子項，並列出繫結至各個物件的屬性。

名稱	說明	屬性
context	訊息處理管道內容的包裝函式，以及 ProxyEndpoint 和 TargetEndpoint 執行的要求和回應流程。	流程、工作階段
context.proxyRequest	代表傳送至 ProxyEndpoint 的要求訊息 (從要求應用程式傳送至 API Proxy) 的物件	標頭、查詢參數、方法、主體、網址
context.targetRequest	這個物件代表從 TargetEndpoint 傳出的要求訊息 (從 API Proxy 到後端服務)。	標頭、查詢參數、方法、主體、網址
context.targetResponse	代表內送目標回應訊息的物件 (從後端服務到 API Proxy)	標頭、內容、狀態
context.proxyResponse	代表輸出 Proxy 回應訊息的物件 (從 API Proxy 傳送至要求應用程式)	標頭、內容、狀態
context.flow	目前流程的名稱。	請參閱 context.flow。
context.session	名稱/值組合的地圖，可用於在相同環境中執行的兩個不同步驟之間傳遞物件。例如 context.session['key'] = 123。	如要進一步瞭解使用這個物件的時機，請參閱「context.session['hello'] = {} 和 context.setVariable("hello", {}) 之間有何差異？」一文。

context object methods

context.getVariable()

擷取預先定義或自訂變數的值。

語法

context.getVariable("variable-name");

範例

如要取得當年度的值，請按照下列步驟操作：

var year = context.getVariable('system.time.year');

context.setVariable()

設定自訂變數的值，或任何可寫入的預先定義變數。

語法

context.setVariable("variable-name", value);

範例

設定變數的常見情境是 API Proxy 必須動態寫入目標網址。下列 JavaScript 會取得名為 USER.name 的變數值，將該值附加為網址 http://mocktarget.apigee.net?user= 的查詢參數，然後將預先定義的 target.url 設為該值。

context.setVariable("target.url", "http://mocktarget.apigee.net/user?user="+context.getVariable("USER.name"));

提示：任何可寫入的預先定義變數和任何自訂變數，都可以透過 JavaScript 動態設定。如需預先定義變數的完整清單，請參閱「流程變數參考資料」。

context.removeVariable()

從內容中移除變數。

語法

context.removeVariable('variable-name');

背景資訊物件屬性

context.flow

flow 屬性是字串，用於識別目前的 API Proxy 流程。這項屬性用於指出 JavaScript 所附加的流程。支援的值如下：

• PROXY_REQ_FLOW
• PROXY_RESP_FLOW
• TARGET_REQ_FLOW
• TARGET_RESP_FLOW

每個流程名稱都包含 PreFlow、PostFlow，以及 ProxyEndpoint 或 TargetEndpoint 中定義的任何條件流程。

如果常見的 JavaScript 會在多個流程中執行，但行為可能會因執行流程而異，這個選用屬性就很有用。如果 JavaScript 模組要在多個 API Proxy 中重複使用，且程式碼必須先檢查目前的 Flow 才能執行邏輯，請使用 Flow 屬性。

示例

僅在 targetRequest Flow 上設定 HTTP 標頭：

if (context.flow=="TARGET_REQ_FLOW") {
     context.targetRequest.headers['TARGET-HEADER-X']='foo';
}

僅在 proxyResponse Flow 中設定內容：

if (context.flow=="PROXY_RESP_FLOW") {
     context.proxyResponse.content='bar';
}

context.session

名稱/值組合的對應，可用於在同一個訊息環境中執行的兩個政策之間傳遞物件。

注意：請務必瞭解使用 context.session 取得/設定變數，與使用 context.getVariable() 和 context.setVariable() 的差異。詳情請參閱這篇 Apigee 社群討論。

示例

在工作階段中設定值：

context.session['key']  = 123;

從工作階段取得值：

var value = context.session['key']; // 123

範例：如要查看使用 context.session 物件的運作範例，請參閱非同步回呼範例 API 代理。

背景資訊物件子項

如下所示，完整的 API Proxy 流程包含四個不同的階段，每個階段都有相關聯的訊息物件，這些物件是內容物件的子項：

• context.proxyRequest：從要求用戶端收到的傳入要求訊息。
• context.targetRequest：傳送至後端服務的外送要求訊息。
• context.proxyResponse：傳回給要求用戶端的外送回覆訊息。
• context.targetResponse：從後端服務收到的入埠要求訊息。

以下各節說明這些物件的方法和屬性：

• context.*Request 子物件
• context.*Response 子物件

context.*Request 子項物件

在 API Proxy 中執行的每筆 HTTP 交易，都會建立兩個要求訊息物件：一個是傳入 (來自用戶端的要求)，另一個是傳出 (API Proxy 產生並提交至後端目標的要求)。

context 物件具有代表這些要求訊息的子項物件：context.proxyRequest 和 context.targetRequest。這些物件可讓您在 JavaScript 程式碼執行時，存取要求流程中範圍內的屬性。

注意：您也可以使用簡寫物件 request，在要求流程中存取這些屬性。request 物件會參照 context.proxyRequest 或 context.targetRequest，視 JavaScript 程式碼在流程中的執行位置而定。

context.*Request 子項物件屬性

屬性名稱	說明
url	url 屬性是讀取/寫入便利屬性，可合併 targetRequest 的配置、主機、通訊埠、路徑和查詢參數。 要求的完整網址是由下列屬性組成： 通訊協定：網址的通訊協定 (例如 HTTP、HTTPS) 通訊埠：通訊埠 (例如：80、443) 主機：網址的主機 (例如 www.example.com) 路徑：URI 的路徑 (例如 /v1/mocktarget) 取得 url 時，系統會傳回下列格式的網址： protocol://host:port/path?queryParams
	範例： context.targetRequest.url = 'http://www.example.com/path?q1=1' context.targetRequest.protocol ='https';
headers	HTTP 要求標頭，以 String => List 的對應形式表示
	範例： 這個 HTTP 要求： POST /v1/blogs HTTP/1.1 Host: api.example.com Content-Type: application/json Authorization: Bearer ylSkZIjbdWybfs4fUQe9BqP0LH5Z 下列 JavaScript： context.proxyRequest.headers['Content-Type']; context.proxyRequest.headers['Authorization']; 會傳回下列值 application/json Bearer ylSkZIjbdWybfs4fUQe9BqP0LH5Z
queryParams	要求訊息查詢參數，以 String => List 的對應形式表示。
	範例： "?city=PaloAlto&city=NewYork" 可存取為： context.proxyRequest.queryParams['city']; // == 'PaloAlto' context.proxyRequest.queryParams['city'][0] // == 'PaloAlto' context.proxyRequest.queryParams['city'][1]; // == 'NewYork' context.proxyRequest.queryParams['city'].length(); // == 2
method	HTTP 動詞 (GET、POST、PUT、DELETE。PATCH 等) 與要求相關聯
	範例： 這項要求： POST /v1/blogs HTTP/1.1 Host: api.example.com Content-Type: application/json Authorization: Bearer ylSkZIjbdWybfs4fUQe9BqP0LH5Z 以下 JavaScript： context.proxyRequest.method; 會傳回下列值 POST
body	HTTP 要求的訊息內文 (酬載)。 要求主體包含下列成員： context.targetRequest.body.asXML; context.targetRequest.body.asJSON; context.targetRequest.body.asForm;
	範例： 如果是 XML 內文： <customer number='1'> <name>Fred<name/> <customer/> 如要存取 XML 物件的元素，請按照下列步驟操作： var name = context.targetRequest.body.asXML.name; 如要存取 XML 屬性，請使用 @ 標記。 var number = context.targetRequest.body.asXML.@number; JSON 要求主體： { "a": 1 , "b" : "2" } var a = context.proxyRequest.body.asJSON.a; // == 1 var b = context.proxyRequest.body.asJSON.b; // == 2 如要讀取表單參數，請按照下列步驟操作： "vehicle=Car&vehicle=Truck" v0 = context.proxyRequest.body.asForm['vehicle'][0]; v1 = context.proxyRequest.body.asForm['vehicle'][1];

context.*Response 子項物件

API Proxy 中執行的每筆 HTTP 交易都會建立兩個回應訊息物件：一個是傳入 (來自後端服務的回應)，另一個是傳出 (傳回給用戶端的回應)。

內容物件有子項物件，代表這些回應訊息：context.proxyResponse 和 context.targetResponse。這些物件可讓您在 JavaScript 程式碼執行時，存取範圍內回應流程中的屬性。

注意：您也可以使用簡寫物件 response，從回應流程存取這些屬性。response 物件會參照 context.proxyResponse 或 context.targetResponse，視 JavaScript 程式碼在流程中的執行位置而定。

context.*回應物件屬性

屬性名稱	說明
headers	回應訊息的 HTTP 標頭，以 String => List 的對應形式表示。
	範例： var cookie = context.targetResponse.headers['Set-Cookie'];
status	狀態碼，並以屬性形式提供狀態訊息。狀態碼和狀態訊息都可做為屬性。
	範例： var status = context.targetResponse.status.code; // 200 var msg = context.targetResponse.status.message; // "OK"
content	回應訊息的 HTTP 主體 (酬載內容)。 回應內容包含下列成員： context.targetResponse.content.asXML; context.targetResponse.content.asJSON;

使用 .asXML 標記法

您可以使用 .asXML 標記，輕鬆逐步瀏覽 XML 文件。 本節說明如何使用這項標記，以及這項標記與 request.content 和 context.proxyRequest.content 的差異。

例如：

request.content.asXML

或

context.proxyRequest.content.asXML

*.content 和 *.content.asXML 形式都可用於字串環境，JavaScript 會強制將其轉換為字串。如果是前者 (*.content)，字串會包含所有宣告和 XML 註解。在後者 (*.content.asXML) 中，結果的字串值會清除宣告和註解。

範例

msg.content:

<?xml version="1.0" encoding="UTF-8"?>
<yahoo:error xmlns:yahoo="http://yahooapis.com/v1/base.rng" xml:lang="en-US">
   <yahoo:description>Please provide valid credentials. OAuth oauth_problem="unable_to_determine_oauth_type", realm="yahooapis.com"
   </yahoo:description>
</yahoo:error>
<!-- mg023.mail.gq1.yahoo.com uncompressed/chunked Sat Dec 14 01:23:35 UTC 2013 -->

msg.content.asXML:

<?xml version="1.0" encoding="UTF-8"?>
<yahoo:error xmlns:yahoo="http://yahooapis.com/v1/base.rng" xml:lang="en-US">
   <yahoo:description>Please provide valid credentials. OAuth oauth_problem="unable_to_determine_oauth_type", realm="yahooapis.com"
   </yahoo:description>
</yahoo:error>

此外，您也可以指定元素和屬性的名稱，使用 .asXML 表單遍歷 XML 階層。無法使用其他語法遍歷階層。

使用 JavaScript print() 陳述式進行偵錯

如果您使用 JavaScript 政策執行自訂 JavaScript 程式碼，請注意，您可以使用 print() 函式將偵錯資訊輸出至偵錯工具。這項函式可直接透過 JavaScript 物件模型使用。例如：

if (context.flow=="PROXY_REQ_FLOW") {
     print("In proxy request flow");
     var username = context.getVariable("request.queryparam.user");
     print("Got query param: " + username);
     context.setVariable("USER.name", username);
     print("Set query param: " + context.getVariable("USER.name"));
}


if (context.flow=="TARGET_REQ_FLOW") {
     print("In target request flow");
     var username = context.getVariable("USER.name");
     var url = "http://mocktarget.apigee.net/user?"
     context.setVariable("target.url", url + "user=" + username);
     print("Callout to URL: ", context.getVariable("target.url"));
}

如要查看輸出內容，請選取「Debug」視窗底部的「Output from all transactions」。您也可以在名為 stepExecution-stdout 的偵錯屬性中找到輸出內容。

使用 httpClient 進行 JavaScript 呼叫

在 API Proxy 流程中執行的自訂 JavaScript 程式碼中，使用 httpClient 對任何網址發出多個並行非同步 HTTP 要求。httpClient 物件是由 Apigee JavaScript 物件模型公開。

關於 httpClient

httpClient 物件會透過 JavaScript 物件模型，公開給在 Apigee 上執行的自訂 JavaScript 程式碼。如要將自訂 JavaScript 附加至 API Proxy，請使用 JavaScript 政策。政策執行時，系統會執行自訂 JavaScript 程式碼。

httpClient 物件可用於開發複合服務或混搭服務。舉例來說，您可以將多個後端呼叫合併為單一 API 方法。

注意：我們不建議使用 JavaScript 政策記錄資料。MessageLogging 政策更適合用於記錄至 Splunk、Sumo 和 Loggly 等第三方記錄平台，而且您可以在 PostClientFlow 中執行 MessageLogging 政策，在回應傳回給用戶端後執行，藉此提升 API 代理效能。

以下是基本的使用模式。建立 Request 物件，為該物件指派網址 (例如要呼叫的後端服務)，然後使用該要求物件呼叫 httpClient.send。

var myRequest = new Request();
myRequest.url = "http://www.example.com";
var exchangeObj = httpClient.send(myRequest);

httpClient 參考資料

HTTP 用戶端會公開兩種方法：get() 和 send()。

httpClient.get()

簡單 HTTP GET 要求的便利方法，不支援 HTTP 標頭。

用量

var exchangeObj = httpClient.get(url);

退貨

這個方法會傳回 exchange 物件。這個物件沒有屬性，但會顯示下列方法：

• isError()：(布林值) 如果 httpClient 無法連線至伺服器，則傳回 true。HTTP 狀態碼 4xx 和 5xx 會導致 isError() false，因為連線已完成，且傳回了有效的狀態碼。如果 isError() 傳回 true，則呼叫 getResponse() 會傳回 JavaScript undefined。
• isSuccess()：(布林值) 如果傳送作業完成且成功，則傳回 true。
• isComplete()：(布林值) 如果要求完成，則傳回 true。
• waitForComplete()：暫停執行緒，直到要求完成 (成功或發生錯誤)。
  反模式： 不建議使用 waitForComplete，因為這是一種反模式。建議改用回呼。 詳情請參閱「反模式：在 JavaScript 程式碼中使用 waitForComplete()」。
• getResponse()：(物件) 如果 httpClient.send() 已完成且成功，則傳回回應物件。傳回的物件具有與 context.proxyResponse 物件相同的方法和屬性。請參閱內容物件摘要。
• getError()：(字串) 如果呼叫 httpClient.send() 導致錯誤，則以字串形式傳回錯誤訊息。

示例

傳送已完整設定的 Request 物件，其中包含 HTTP 要求的屬性。使用非封鎖回呼處理回應。

注意： 建議使用回呼非同步處理回應，我們不建議使用 waitForComplete() 函式，因為這是一種反模式。另請參閱反模式：在 JavaScript 程式碼中使用 waitForComplete()。

// Add the required the headers for making a specific API request
var headers = {'X-SOME-HEADER' : 'some value' };
// Make a GET API request along with headers
var myRequest = new Request("http://www.example.com","GET",headers);

// Define the callback function and process the response from the GET API request
function onComplete(response,error) {
 // Check if the HTTP request was successful
    if (response) {
      context.setVariable('example.status', response.status);
     } else {
      context.setVariable('example.error', 'Woops: ' + error);
     }
}

// Specify the callback Function as an argument
httpClient.get(myRequest, onComplete);

使用 JavaScript 政策

使用 JavaScript 政策，將自訂 JavaScript 程式碼附加至 Proxy 流程。 請參閱「 JavaScript 政策」。

相關主題

• JavaScript 政策
• JavaScript 物件模型
• 反面模式簡介