Codificación en Base64

La codificación Base64 se utiliza para los elementos del parámetro de entrada ' args ' que pueden romper la estructura de datos interna del parámetro ' args '. Codificarlo como Base64 ayuda a garantizar que todo el valor esté formado sólo por caracteres legibles en un alfabeto de 64 caracteres.

Por ejemplo:

"eyAicGxhbmV0MSI6Ik1hcnMiLCAicGxhbmV0MiI6Ikp1cGl0ZXIiIH0="

Codificación de porcentaje (codificación URL )

La codificación de porcentaje se utiliza ampliamente en la tecnología web. Todos los caracteres de 8 bits se escriben como valor hexadecimal precedido de un signo de porcentaje (%). Este tipo de codificación también se conoce como codificación URL. La función recibe los datos de tipo " form-urlencoded " en formato bruto en el parámetro " __ce_body ".

El servicio de funciones Code Engine pasa los parámetros de la consulta tal cual (el ' ? ' inicial no forma parte de ella) al campo ' __ce_query ' del parámetro ' args '. De esta manera, el código de función recibe este parámetro en formato codificado con URL; por ejemplo:

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

parámetro args ' fijado para argumentos de entrada internos (__ce_*)

El servicio de funciones Code Engine inyecta argumentos de entrada reservados a los datos de entrada ' args.

Los siguientes parámetros pueden aparecer en el argumento ' args ' dependiendo de cómo el llamante proporcione los datos de la solicitud:

Los parámetros de __ce_* internos no se pueden sobrescribir con los datos de solicitud que se proporcionan en la solicitud de HTTP. HTTP llamadas que intentan sobrescribir fallan con el código de estado " 400 " (Solicitud incorrecta).

Contenido del parámetro " args " si el autor de la llamada proporciona los datos de la solicitud mediante parámetros de consulta

Una función recibe datos de parámetros de consulta como pares clave-valor en el parámetro __ce_query, y está codificada en porcentaje (codificada en URL ). Además, cada parámetro de consulta es un par clave-valor en el formato descodificado:

Ejemplo Python de acceso a parámetros de consulta:

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

Ejemplo de Node.js de acceso a parámetros de consulta:

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;

Contenido del parámetro " args " si el autor de la llamada proporciona los datos de la solicitud mediante datos de cabecera

Una función recibe los datos de cabecera de la solicitud como pares clave-valor en el parámetro ' __ce_headers '. El par clave-valor se convierte a un formato canónico, independientemente del formato que tenga la clave en la interfaz de datos externa. Por ejemplo, tanto " mykey como " MYKEY " se convierten en " Mykey:

Ejemplo Python de acceso a datos de cabecera:

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

Ejemplo de Node.js de acceso a datos de cabecera:

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;

parámetro "args " de los datos de la solicitud de tipo de contenido " application/json

Una función recibe las claves y los valores del documento JSON como parámetros de propiedad de nivel superior dedicados.

Cuando no se establece ningún valor para Content-type en la solicitud HTTP, la función Code Engine utiliza application/json de forma predeterminada.

Además, la carga útil JSON se pone a disposición de la función tal cual (como matriz de bytes) en formato Base64-encoded en el parámetro " __ce_body ".

Ejemplo Python de acceso a los datos de entrada ' application/json:

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

Ejemplo de Node.js de acceso a datos de entrada ' application/json ':

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;

parámetro "args " de los datos de la solicitud de tipo de contenido " application/octet-stream

Una función recibe datos binarios en formato Base64-encoded para los datos binarios ' __ce_body ' en el parámetro ' __ce_body ':

Ejemplo Python de acceso a los datos de entrada ' application/octet-stream:

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

Ejemplo de Node.js de acceso a datos de entrada ' application/octet-stream ':

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;

parámetro "args " de los datos de la solicitud de tipo de contenido " text/plain

Una función recibe datos de tipo texto en formato Base64-encoded en el parámetro ' __ce_body ':

La lógica del programa de la función podría tener que desescaparlos para volver a crear los datos originales.

Ejemplo Python de acceso a los datos de entrada ' text/plain:

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

Ejemplo de Node.js de acceso a datos de entrada ' text/plain ':

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

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

module.exports.main = main;

parámetro "args " de los datos de la solicitud de tipo de contenido " application/x-www-form-urlencoded

Una función recibe los datos completos del cuerpo en formato de texto codificado en el parámetro " __ce_body ":

Ejemplo Python de acceso a los datos de entrada ' application/x-www-form-urlencoded:

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

Ejemplo de Node.js de acceso a datos de entrada ' application/x-www-form-urlencoded ':

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

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

module.exports.main = main;

parámetro 'args ' a partir de datos de solicitud de tipo de contenido ' application/x-www-form-urlencoded y parámetros de consulta

Todas las combinaciones de tipos de datos mixtos son posibles, pero tenga en cuenta que para las solicitudes de tipo " HTTP " con parámetros de consulta " URL " y parámetros de cuerpo, los parámetros de cuerpo tienen prioridad sobre los parámetros de consulta.

Valor del cuerpo del content-type ' application/json

El código de la función debe proporcionar el valor del elemento " body " como una estructura de datos válidaNodeJs-JSON o Python). Las claves y los valores de la estructura de datos deben seguir las reglas de sintaxis JSON para que el servicio Code Engine pueda entregar los datos de respuesta en la sección de datos de respuesta application/json HTTP.

Las barras invertidas (\) y las comillas dobles (") en la estructura de datos se entregan en formato de texto codificado en la sección de datos de respuesta de HTTP.

Ejemplo Python de una respuesta ' 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,
    }

Ejemplo Node.js de una respuesta ' 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;

Valor del cuerpo del content-type ' application/octet-stream

Los datos de resultado del código de función deben Base64-encoded antes de añadirlos a la estructura de resultados.

Ejemplo Python de una respuesta ' 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,
  }

Ejemplo Node.js de una respuesta ' 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;

Valor del cuerpo del content-type ' text/plain

El código de la función debe proporcionar toda la respuesta en una sola cadena. El servicio de funciones Code Engine no comprueba los datos de respuesta; los datos se transfieren a la persona que realiza la llamada tal como se proporcionan.

Ejemplo Python de una respuesta ' text/plain:

def main(args):
  result_body = "myfolder_myFile"

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

Valor del cuerpo del tipo de contenido " application/x-www-form-urlencoded (contenido codificado en porcentaje)

El código de función debe ayudar a garantizar que los datos de respuesta estén codificados con el códig URL antes de que se añadan a la estructura de datos de resultados. El servicio de funciones de Code Engine no comprueba la sintaxis correcta de los datos de respuesta. Los datos se transfieren a la persona que llama según lo previsto.

Ejemplo Python de una respuesta ' 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,
  }

campos de cabecera HTTP

El encabezado " HTTP " contiene todos los pares clave-valor que el código de función añadió a la estructura de datos de resultados.

El servicio de funciones Code Engine añade los siguientes pares clave-valor:

Los nombres de las claves de cabecera se responden siempre en minúsculas.

Código de estado HTTP

El origen del código de estado de la función HTTP puede ser el propio servicio de funciones de Code Engine o el código de estado establecido por el código de función. La presencia del campo de cabecera " x-faas-statuscode " es el indicador del origen.

El significado del código de estado HTTP puede leerse en la documentación de funciones de Code Engine si el campo de encabezado x-faas-actionstatus no está configurado. Sin embargo, si el campo de encabezado está establecido, entonces la lógica de la función define el significado del código de estado de la función HTTP.

Code Engine funciones El servicio ejecuta una comprobación de validez limitada en los datos de respuesta y el tipo de contenido, y devuelve un código de estado HTTP de 400 si el formato de datos o la codificación (generada por el código de función) no son válidos.

HTTP datos de respuesta

Los datos de respuesta de la interfaz de datos externa ( HTTP ) son idénticos a los suministrados en la estructura de datos de resultados por el código de función. Sólo si ' MIME-Type ' es ' application/json ' se modifican la clave y los valores en la respuesta JSON proporcionada. Se escapan todas las barras invertidas y las comillas dobles.

Por ejemplo, la persona que llama recibe datos de respuesta " application/json ". El código de función que proporciona los datos de respuesta es el siguiente:

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

El cliente ' curl ' que utiliza la respuesta ' statusCcode, los campos ' header, y los datos de respuesta, es el siguiente:

  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