與函數交換數據

Base64 編碼

Base64編碼用於輸入 args 參數中的元素，這可能會破壞 args 參數的內部資料結構。 將其編碼為Base64有助於確保整個值僅包含 64 個字元字母表中的可讀字元。

例如：

"eyAicGxhbmV0MSI6Ik1hcnMiLCAicGxhbmV0MiI6Ikp1cGl0ZXIiIH0="

百分比編碼 ( URL-encoding)

百分比編碼廣泛應用於網路技術。 所有 8 位元字元都以十六進位值寫成，前面加上百分比符號 (%)。這種編碼方式也稱為 URL-encoding。 此函數在 __ce_body 參數中接收原始格式的 form-urlencoded 類型資料。

Code Engine函數服務原樣將查詢參數（前導 ? 不是其中的一部分）傳遞到「args 參數的 __ce_query 欄位中。 這樣，函式碼就能以 URL 編碼格式接收此參數；例如：

"x%5cb=1%22f4%20and%20"

內部輸入參數的 args 參數集（ __ce_* ）

Code Engine函數服務將保留的輸入參數注入 args 輸入資料。

以下參數可以出現在 args 參數中，取決於呼叫者提供請求資料的方式：

__ce_* 內部參數不能被 HTTP 請求中提供的請求資料覆蓋。 HTTP 嘗試覆寫的呼叫失敗，狀態代碼為 (Bad Request)。400

如果呼叫者透過查詢參數提供請求數據，則 args 參數的內容

函數以 __ce_query 參數中的關鍵值對接收查詢參數資料，並採用百分比編碼 ( URL-encoded)。 此外，每個查詢參數都是解碼格式中的鍵值對：

存取查詢參數的Python範例：

import os
def main(args):
  query_parm_1 = args.get("key", "default_value") # get the value of one query parameter

  try:
    query = args["__ce_query"]  # get all query parms
  except:
    query= "not part of request"

  return {
    "statusCode": 200,
    "body": query,
  }

Node.js存取查詢參數的範例：

function main(args) {
  var query_parm_1 = args.key     // get the value of one query parameter
  var query = args.__ce_query     // get all query parameters

  return {
    statusCode: 200,
    "body" : query,
  };
}

module.exports.main = main;

如果呼叫者透過標頭數據提供請求數據，則 args 參數的內容

函數接收請求標頭資料作為 __ce_headers 參數中的鍵值對。 無論密鑰在外部資料介面上設定哪種格式，鍵值對都會轉換為規範格式。 例如，mykey 或 MYKEY 都轉換為 Mykey：

訪問頭資料的Python範例：

import os
def main(args):

  try:
    header = args["__ce_headers"]  # get complete header
    # value_1 = args["__ce_headers"]["Key_1"]  # get value of the Header parm with "Key_1"
  except:
    header = "not part of request"

  return {
    "statusCode": 200,
    "body": header,
  }

Node.js存取標頭資料的範例：

function main(args) {
  // var header_parm_1 = args.__ce_headers.Key_1  //get the value of one header parameter
  var header = args.__ce_headers  // get all header parameters

  return {
    statusCode: 200,
    "body" : header,
  };
}

module.exports.main = main;

來自內容類型 application/json 的請求資料的 args 參數

函數接收 JSON 文件的鍵和值作為專用的頂層屬性參數。

如果 HTTP 請求中沒有為 Content-type 設定值，則 Code Engine 函式會使用 application/json 作為預設值。

此外，JSON 負載在 __ce_body 參數中以Base64-encoded格式按原樣（作為位元組數組）提供給函數。

存取 application/json 輸入資料的Python範例：

import os
def main(args):
  try:
    body_encoded = args["__ce_body"]  # get complete header (base64 encoded)
    value_1 = args["key_1"]           # get value of the Header parm with "key_1"
  except:
    value_1 = "not part of request"

  return {
    "statusCode": 200,
    "body": value_1,
  }

存取 application/json 輸入資料的Node.js範例：

function main(args) {
  var body  = args.__ce_body  // get complete request body (base64 encoded)
  var value_1 = args.key_1    // get value of one single key

  return {
    statusCode: 200,
    "body" : value_1,
  };
}

module.exports.main = main;

來自內容類型 application/octet-stream 的請求資料的 args 參數

函數接收 __ce_body 參數中 __ce_body 資料的Base64-encoded格式的二進位資料：

存取 application/octet-stream 輸入資料的Python範例：

import os
import base64

def main(args):
  try:
    body = base64.b64decode(args['__ce_body']).decode("utf-8")   # read binary data into the body variable
  except:
    body = "not binary data found"

  return {
    "headers": { "Content-Type": "text/plain" },  # text/plain, if ensured binary data do not conain backslash and double quotes
    "statusCode": 200,
    "body": body,
  }

存取 application/octet-stream 輸入資料的Node.js範例：

function main(args) {
  var base64EncodedBody = args.__ce_body   // get complete request body (base64 encoded)
  var body = Buffer.from(args.__ce_body, 'base64').toString('utf-8') //  read binary data into the body variable

  return {
    statusCode: 200,
    "body" : body,
  };
}

module.exports.main = main;

來自內容類型 text/plain 的請求資料的 args 參數

函數在 __ce_body 參數中接收Base64-encoded格式的文字類型資料：

該函數的程式邏輯可能需要對它們進行轉義以重新建立原始資料。

存取 text/plain 輸入資料的Python範例：

import os
def main(args):
  body = args['__ce_body']  # get request body, is text encoded (escaped)

  return {
    "headers": { "Content-Type": "text/plain" },
    "statusCode": 200,
    "body": body,
  }

存取 text/plain 輸入資料的Node.js範例：

function main(args) {
  var body  = args.__ce_body  // get complete request body (text encoded)

  return {
    statusCode: 200,
    "body" : body,
  };
}

module.exports.main = main;

來自內容類型 application/x-www-form-urlencoded 的請求資料的 args 參數

函數在 __ce_body 參數中接收文字編碼格式的完整正文資料：

存取 application/x-www-form-urlencoded 輸入資料的Python範例：

import os
def main(args):
  body = args['__ce_body']  # get request body, is url-encoded (%)

  return {
    "headers": { "Content-Type": "text/plain" },
    "statusCode": 200,
    "body": body,
  }

存取 application/x-www-form-urlencoded 輸入資料的Node.js範例：

function main(args) {
  var body  = args.__ce_body  //get request body, is url-encoded (%)

  return {
    statusCode: 200,
    "body" : body,
  };
}

module.exports.main = main;

內容類型 application/x-www-form-urlencoded 請求資料中的 args 參數和查詢參數

混合資料類型的所有組合都是可能的，但請注意，對於 URL 查詢參數和正文參數的 HTTP 請求，正文參數優先於查詢參數。

內容類型 application/json 的正文值

函數程式碼必須提供 body 元素的值作為有效的資料結構（ NodeJs-JSON或Python-Dictionary）。 資料結構的鍵和值必須遵循 JSON 語法規則，以便 Code Engine 服務能夠在 application/json HTTP 回應資料部分傳送回應資料。

資料結構中的反斜線 (\) 和雙引號 (") 會在 HTTP 回應資料部分以文字編碼格式傳送。

application/json 響應的Python範例：

  import os
  def main(args):
    # python dictionary
    result_body = { "key_1" : "myfolder\myFile" }

    return {
      "headers": {
        "Content-Type": "application/json",
      },
      "statusCode": 200,
      "body": result_body,
    }

application/json 回應的Node.js範例：

function main(args) {
  // JSON data structure
  // Note: Backslash must be text encoded
  result_body =  { "key1" : "myfolder\\myFile"}

  return {
	  statusCode: 200,
	  headers: {
	    'Content-Type': "application/json",
	  },
	  "body" : result_body ,
  };
}
module.exports.main = main;

內容類型 application/octet-stream 的正文值

在將函數程式碼的結果資料新增至結果結構之前，必須先對其進行Base64-encoded。

application/octet-stream 響應的Python範例：

import os
import base64

def main(args):
  result_body = "myfolder_myFile"
  enc_result_body=base64.encodebytes(result_body.encode()).decode("utf-8").strip()

  return {
    "headers": {
      "Content-Type": "application/octet-stream",
    },
    "statusCode": 200,
    "body": enc_result_body,
  }

application/octet-stream 回應的Node.js範例：

function main(args) {
  var result_body = "###\unreturned body###\n"
  var buff = new Buffer(result_body , 'utf8');

  return {
    statusCode: 200,
    headers: {
      'Content-Type': "application/octet-stream",
    },
    "body" : buff.toString('base64') ,
  };
}

module.exports.main = main;

內容類型 text/plain 的正文值

函數代碼必須在單一字串中提供整個回應。 Code Engine函數服務不檢查回應資料；資料按照提供的方式傳輸給呼叫者。

text/plain 響應的Python範例：

def main(args):
  result_body = "myfolder_myFile"

  return {
    "headers": {
      "Content-Type": "text/plain;charset=utf-8",
    },
    "statusCode": 200,
    "body": result_body,
  }

內容類型 application/x-www-form-urlencoded 的主體值（百分比編碼內容）

函式代碼必須有助於確保回應資料在加入結果資料結構之前已被 URL- 編碼。 Code Engine 函式服務不會檢查回應資料的語法是否正確。 資料按照提供的方式傳輸給呼叫者。

application/x-www-form-urlencoded 響應的Python範例：

import os
def main(args):
  result_body = "myfolder%20myFile"

  return {
    "headers": {
    "Content-Type": "application/x-www-form-urlencoded",
    },
    "statusCode": 200,
    "body": result_body,
  }

HTTP 標頭欄位

HTTP 標頭包含函式代碼新增至結果資料結構的所有鍵值對。

Code Engine函數服務新增下列鍵值對：

標頭鍵名始終以小寫形式回覆。

HTTP 狀態碼

HTTP 狀態代碼的來源可以是 Code Engine 功能服務本身，也可以是功能代碼設定的狀態代碼。 標頭欄位 x-faas-statuscode 的存在是來源的指示符。

如果 x-faas-actionstatus 標頭欄位未設定，HTTP 狀態碼的意義可在 Code Engine 函式文件中讀取。 但是，如果設定了標頭欄位，那麼函式的邏輯就定義了 HTTP 狀態碼的意義。

Code Engine 函式服務會對回應資料和內容類型執行有限的有效性檢查，如果資料格式或編碼（由函式碼產生）無效，則會返回 狀態代碼。HTTP 400

HTTP 回應資料

HTTP 外部資料介面上的回應資料與功能代碼在結果資料結構中提供的相同。 只有當 MIME-Type 為 application/json 時，所提供的 JSON 回應中的鍵和值才會被修改。 所有反斜線和雙引號都會被轉義。

例如，呼叫者取得 application/json 回應資料。 提供響應資料的函數程式碼如下：

import os
def main(args):
  # python dictionary
  result_body = { "key_1" : "myfolder\myFile" }

  return {
    "headers": {
      "Content-Type": "application/json",
      "key" : "sample",
    },
    "statusCode": 200,
    "body": result_body,
  }

使用回應 statusCcode、header 欄位和回應資料的 curl 客戶端如下：

  curl -v -i  https://sample.1kweru2e873.eu-gb.codeengine.appdomain.cloud/
	 -> Response:
	stdout>
   * Host default-encoded-response.1lpigeajq5fg.us-east.codeengine.appdomain.cloud:443 was resolved.
   * IPv6: 2606:4700:90:0:7554:9304:2cbe:8cbf
   * IPv4: 172.65.197.223
   * using HTTP/1.x
   > GET / HTTP/1.1
   > Host: default-encoded-response.1lpigeajq5fg.us-east.codeengine.appdomain.cloud
   > User-Agent: curl/8.8.0
   > Accept: *//*

   * Request completely sent off
   < HTTP/1.1 200 OK
   < content-type: application/json
   < key: sample
   < x-faas-actionstatus: 200
   < x-faas-activation-id: 5cbab12c-5c6e-4000-96cf-0f7fcb42a979
   < x-request-id: e7098271-4780-4893-bbd4-64d4c8d7605e
   < content-length: 13
   { "key_1" : "myfolder\\myFile }* Connection