Base64 인코딩

입력 ' args 매개변수의 요소 중 ' args ' 매개변수의 내부 데이터 구조를 손상시킬 수 있는 요소에는 Base64 인코딩이 사용됩니다. Base64 인코딩하면 전체 값이 64자 알파벳의 판독 가능한 문자로만 구성되도록 할 수 있습니다.

예를 들어, 다음과 같습니다.

"eyAicGxhbmV0MSI6Ik1hcnMiLCAicGxhbmV0MiI6Ikp1cGl0ZXIiIH0="

퍼센트 인코딩( URL-encoding)

퍼센트 인코딩은 웹 기술에서 널리 사용됩니다. 모든 8비트 문자는 백분율 기호(%)가 앞에 붙은 16진수 값으로 작성됩니다. 이 인코딩 유형은 UTF-8( URL ) 인코딩이라고도 합니다. 이 함수는 ' __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 400 (Bad Request) 상태 코드로 덮어쓰기 시도가 실패합니다.

호출자가 쿼리 파라미터로 요청 데이터를 제공하는 경우 ' 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;

args 콘텐츠 유형의 요청 데이터에서 application/x-www-form-urlencoded 및 쿼리 매개변수

URL 혼합된 데이터 유형의 모든 조합이 가능하지만, 쿼리 파라미터와 본문 파라미터를 사용하는 HTTP 요청의 경우, 본문 파라미터가 쿼리 파라미터보다 우선한다는 점을 고려해야 합니다.

콘텐츠 유형 ' application/json'의 본문 값

함수 코드는 ' body ' 요소의 값을 유효한 데이터 구조NodeJs-JSON 또는 Python)로 제공해야 합니다. Code Engine 서비스가 application/json HTTP 응답 데이터 섹션에 응답 데이터를 전달할 수 있도록 데이터 구조의 키와 값은 JSON 구문 규칙을 따라야 합니다.

데이터 구조의 백슬래시(\)와 큰따옴표(")는 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-encoded로 인코딩되도록 해야 합니다. 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