Base64 编码

Base64编码用于处理输入“args 参数中可能破坏”args 参数内部数据结构的元素。 将其编码为Base64有助于确保整个值仅由 64 个字符字母表中的可读字符组成。

例如：

"eyAicGxhbmV0MSI6Ik1hcnMiLCAicGxhbmV0MiI6Ikp1cGl0ZXIiIH0="

百分比编码（ URL 编码）

百分比编码广泛用于 Web 技术。 所有8位字符都以十六进制值的形式书写，前面带有百分号（%）。这种编码方式也称为 URL 编码。 The function receives the form-urlencoded type data in raw format in the __ce_body parameter.

Code Engine函数服务会将查询参数原样（前导 "? 不在其中）传入 "args 参数的 "__ce_query 字段。 这样，函数代码将以 URL 编码格式接收此参数；例如：

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

args parameter set for internal input arguments (__ce_*)

Code Engine功能服务会向 "args 输入数据注入保留的输入参数。

以下参数可以出现在 "args 参数中，具体取决于调用者如何提供请求数据：

HTTP 请求中提供的请求数据无法覆盖内部 __ce_* 参数。 HTTP 尝试覆盖的调用失败，状态码为 （错误请求）。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;

args parameter from request data of content-type application/json

函数接收 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;

args parameter from request data of content-type application/octet-stream

函数接收Base64-encoded格式的二进制数据，用于“__ce_body 参数中的”__ce_body 二进制数据：

访问 "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;

args parameter from request data of content-type text/plain

函数接收 "__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;

args parameter from request data of content-type application/x-www-form-urlencoded

函数在参数 "__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;

args parameter from request data of content-type application/x-www-form-urlencoded and query parameters

所有混合数据类型的组合都是可能的，但请注意，对于带有 URL 查询参数和正文参数的 HTTP 请求，正文参数优先于查询参数。

内容类型 "application/json 的正文值

功能代码必须以有效数据结构NodeJs-JSON或Python）的形式提供 "body 元素的值。 数据结构的键和值必须遵循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,
    }

Node.js示例 "application/json 响应：

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,
  }

Node.js示例 "application/octet-stream 响应：

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 报头字段，可在 Code Engine 功能文档中查看 HTTP 状态代码的含义。 但是，如果设置了标题字段，则函数的逻辑将定义 HTTP 状态代码的含义。

Code Engine 函数服务会对响应数据和内容类型进行有限的有效性检查，如果数据格式或编码（由函数代码生成）无效，则返回 状态的 代码。400 HTTP

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