Base64 エンコード

args パラメータの内部データ構造を壊す可能性のある、入力「args パラメータ内の要素には、Base64エンコーディングが使用される。 Base64としてエンコードすることで、値全体が64文字のアルファベットの中で読み取り可能な文字のみで構成されていることを保証するのに役立つ。

以下に例を示します。

"eyAicGxhbmV0MSI6Ik1hcnMiLCAicGxhbmV0MiI6Ikp1cGl0ZXIiIH0="

パーセントエンコーディング（ URL エンコーディング）

パーセントエンコーディングは、Web テクノロジーで広く使用されています。 すべての8ビット文字は、パーセント記号（%）を前置した16進数で表記されます。このタイプのエンコードは、 URL エンコードとも呼ばれます。 この関数は、'form-urlencoded 型のデータを生のフォーマットで'__ce_body パラメータに受け取る。

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 エンコード）されます。 また、各クエリーパラメーターは、デコードされたフォーマット内のキーと値のペアである：

クエリパラメータにアクセスする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;

content-typeが'application/json のリクエスト・データから args パラメータ。

関数は、JSONドキュメントのキーと値を、専用の最上位プロパティ・パラメータとして受け取ります。

HTTP リクエストで Content-type に値が設定されていない場合、 Code Engine 機能では application/json がデフォルトとして使用されます。

さらに、JSONペイロードは、そのまま（バイト配列として）Base64-encoded形式で、'__ce_body パラメータで関数に提供される。

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;

content-typeが'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;

content-typeが'text/plain のリクエスト・データから args パラメータ。

関数は、Base64-encodedテキスト型データを'__ce_body パラメータで受け取る：

関数のプログラム・ロジックは、元のデータを再作成するために、それらのエスケープを解除する必要があるかもしれない。

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;

content-typeが'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;

content-typeが'application/x-www-form-urlencoded のリクエストデータとクエリパラメータから args パラメータを取得する

すべての種類の混合データの組み合わせが可能です。ただし、 HTTP リクエストで URL クエリパラメータとボディパラメータを使用する場合、ボディパラメータはクエリパラメータよりも優先されることにご注意ください。

content-type「application/json」のボディ値

関数コードは、'body 要素の値を有効なデータ構造NodeJs-JSONまたはPython）として提供しなければならない。 Code Engine サービスが application/json HTTP のレスポンスデータセクションでレスポンスデータを配信できるように、データ構造のキーと値はJSON構文規則に従う必要があります。

データ構造内のバックスラッシュ（\ ）および二重引用符（" ）は、 HTTP のレスポンスデータセクションではテキストエンコード形式で配信されます。

Pythonの'application/json 応答の例：

  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;

content-type「application/octet-stream」のボディ値

関数コードの結果データは、結果構造体に追加する前にBase64-encodedておく必要がある。

Pythonの'application/octet-stream 応答の例：

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;

content-type「text/plain」のボディ値

関数コードは、応答全体を単一の文字列で提供しなければならない。 Code Engineファンクション・サービスは、レスポンス・データをチェックしない。

Pythonによる「text/plain 応答の例：

def main(args):
  result_body = "myfolder_myFile"

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

content-type「application/x-www-form-urlencoded」のボディ値（パーセントエンコードされたコンテンツ）

ファンクションコードは、応答データが結果データ構造に追加される前に、 URL エンコードされることを保証するものでなければなりません。 Code Engine の機能サービスは、応答データの正しい構文をチェックしません。 データは、提供されたとおりに発呼側に転送される。

Pythonの'application/x-www-form-urlencoded 応答の例：

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 存在は、オリジンの指標である。

HTTP ステータスコードの意味は、 Code Engine の機能に関するドキュメントで確認できます。ただし、 x-faas-actionstatus ヘッダーフィールドが設定されていない場合に限ります。 しかし、ヘッダーフィールドが設定されている場合、関数のロジックによって 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