Codifica Base64

La codifica Base64 viene utilizzata per gli elementi del parametro di input 'args che possono interrompere la struttura interna dei dati del parametro 'args. La codifica come Base64 garantisce che l'intero valore sia composto solo da caratteri leggibili in un alfabeto di 64 caratteri.

Ad esempio:

"eyAicGxhbmV0MSI6Ik1hcnMiLCAicGxhbmV0MiI6Ikp1cGl0ZXIiIH0="

Codifica percentuale (codifica URL )

La codifica percentuale è ampiamente utilizzata nella tecnologia web. Tutti i caratteri a 8 bit sono scritti come valore esadecimale preceduto da un segno di percentuale (%). Questo tipo di codifica è noto anche come codifica " URL ". La funzione riceve i dati di tipo " form-urlencoded in formato grezzo nel parametro " __ce_body.

Il servizio di funzioni Code Engine passa i parametri della query così come sono (l'iniziale '? non ne fa parte) nel campo '__ce_query del parametro 'args. In questo modo, il codice funzione riceve questo parametro in formato codificato con l' URL; ad esempio:

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

parametro args impostato per gli argomenti di input interni (__ce_*)

Il servizio di funzioni Code Engine inietta argomenti di input riservati nei dati di input " args.

I seguenti parametri possono comparire nell'argomento 'args, a seconda di come il chiamante fornisce i dati della richiesta:

I parametri interni dell' __ce_* e non possono essere sovrascritti con i dati della richiesta forniti nella richiesta dell' HTTP. HTTP chiamate che tentano di sovrascrivere i fallimenti con codice di stato 400 (richiesta errata).

Contenuto del parametro 'args se il chiamante fornisce i dati della richiesta tramite i parametri della query

Una funzione riceve i dati dei parametri di query come coppie chiave-valore nel parametro " __ce_query " ed è codificata in percentuale (codifica " URL "). Inoltre, ogni singolo parametro della query è una coppia chiave-valore nel formato decodificato:

Esempio Python di accesso ai parametri della query:

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

Esempio di accesso ai parametri della query in 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;

Contenuto del parametro 'args se il chiamante fornisce i dati della richiesta tramite dati di intestazione

Una funzione riceve i dati dell'intestazione della richiesta come coppie chiave-valore nel parametro " __ce_headers. La coppia chiave-valore viene convertita in un formato canonico, indipendentemente dal formato in cui la chiave è impostata sull'interfaccia dati esterna. Ad esempio, sia mykey che MYKEY vengono convertiti in Mykey:

Esempio Python di accesso ai dati di intestazione:

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

Esempio di accesso ai dati di intestazione in 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 dai dati della richiesta di tipo content-type application/json

Una funzione riceve le chiavi e i valori del documento JSON come parametri di proprietà di primo livello dedicati.

Quando nella richiesta " HTTP " non viene impostato alcun valore per " Content-type ", la funzione " Code Engine " utilizza " application/json " come valore predefinito.

Inoltre, il payload JSON viene messo a disposizione della funzione così com'è (come array di byte) in formato Base64-encoded nel parametro " __ce_body.

Esempio Python di accesso ai dati di input di '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,
  }

Esempio di accesso ai dati di input di 'application/json in 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 dai dati della richiesta di tipo content-type application/octet-stream

Una funzione riceve dati binari in formato Base64-encoded per i dati binari '__ce_body nel parametro '__ce_body:

Esempio Python di accesso ai dati di input di '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,
  }

Esempio di accesso ai dati di input di 'application/octet-stream in 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 dai dati della richiesta di tipo content-type text/plain

Una funzione riceve dati di tipo testo in formato Base64-encoded nel parametro " __ce_body:

La logica del programma della funzione potrebbe aver bisogno di disincapsularli per ricreare i dati originali.

Esempio Python di accesso ai dati di input di '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,
  }

Esempio di accesso ai dati di input di 'text/plain in 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 dai dati della richiesta di tipo content-type application/x-www-form-urlencoded

Una funzione riceve i dati completi del corpo in formato codificato in testo nel parametro " __ce_body:

Esempio Python di accesso ai dati di input di '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,
  }

Esempio di accesso ai dati di input di 'application/x-www-form-urlencoded in 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;

parametro args dai dati della richiesta di tipo contenuto 'application/x-www-form-urlencoded e dai parametri della query

Sono possibili tutte le combinazioni di tipi di dati misti, ma si consideri che per le richieste di tipo " HTTP " con parametri di query " URL " e parametri del corpo, i parametri del corpo hanno la precedenza sui parametri di query.

Valore del corpo del tipo di contenuto " application/json

Il codice della funzione deve fornire il valore dell'elemento 'body come struttura dati validaNodeJs-JSON o Python). Le chiavi e i valori della struttura dati devono seguire le regole di sintassi JSON in modo che il servizio Code Engine possa fornire i dati di risposta nella sezione dati di risposta application/json HTTP.

I backslash (\) e le doppie virgolette (") nella struttura dei dati vengono forniti in formato codificato in testo nella sezione dei dati di risposta HTTP.

Esempio Python di risposta " 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,
    }

Esempio di risposta 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;

Valore del corpo del tipo di contenuto " application/octet-stream

I dati del risultato per il codice funzione devono essere Base64-encoded prima di essere aggiunti alla struttura del risultato.

Esempio Python di risposta " 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,
  }

Esempio di risposta 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;

Valore del corpo del tipo di contenuto " text/plain

Il codice funzione deve fornire l'intera risposta in un'unica stringa. Il servizio di funzioni Code Engine non controlla i dati di risposta; i dati vengono trasferiti al chiamante come previsto.

Esempio Python di risposta " text/plain:

def main(args):
  result_body = "myfolder_myFile"

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

Valore del corpo del tipo di contenuto 'application/x-www-form-urlencoded (contenuto codificato in percentuale)

Il codice funzione deve garantire che i dati di risposta siano codificati con l' URL, prima di essere aggiunti alla struttura dei dati di risultato. Il servizio funzioni dell' Code Engine e non controlla la correttezza della sintassi dei dati di risposta. I dati vengono trasferiti al chiamante come previsto.

Esempio Python di risposta " 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 campi di intestazione

L'intestazione " HTTP " contiene tutte le coppie chiave-valore che il codice funzione ha aggiunto alla struttura dati del risultato.

Il servizio di funzioni Code Engine aggiunge le seguenti coppie chiave-valore:

I nomi delle chiavi d'intestazione sono sempre ribattuti in minuscolo.

Codice di stato HTTP

L'origine del codice di stato dell' HTTP e può essere il servizio funzioni dell' Code Engine e stesso o il codice di stato impostato dal codice funzione. La presenza del campo di intestazione " x-faas-statuscode è l'indicatore dell'origine.

Il significato del codice di stato dell' HTTP e può essere letto nella documentazione delle funzioni dell' Code Engine e se il campo dell'intestazione dell' x-faas-actionstatus e non è impostato. Tuttavia, se il campo di intestazione è impostato, la logica della funzione definisce il significato del codice di stato dell' HTTP.

Code Engine il servizio funzioni esegue un controllo di validità limitato sui dati e sul tipo di contenuto della risposta e restituisce un codice di stato HTTP di 400 se il formato o la codifica dei dati (generati dal codice funzione) non sono validi.

HTTP dati di risposta

I dati di risposta dell' HTTP e sull'interfaccia dati esterna sono identici a quelli forniti nella struttura dati dei risultati dal codice funzione. Solo se il 'MIME-Type è 'application/json, la chiave e i valori nella risposta JSON fornita vengono modificati. Tutti i backslash e le virgolette doppie vengono evasi.

Ad esempio, il chiamante riceve i dati di risposta " application/json. Il codice funzione che fornisce i dati di risposta è il seguente:

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

Il client 'curl che utilizza i campi 'statusCcode, 'header e i dati della risposta è il seguente:

  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