ホーム
製品
OpenShift Container Platform
4.9
Serverless
6.12. 関数開発リファレンスガイド

6.12. 関数開発リファレンスガイド

OpenShift Serverless Functions は、基本的な関数を作成するために使用できるテンプレートを提供します。テンプレートは、関数プロジェクトのボイラープレートを開始し、kn func ツールで使用できるように準備します。各関数テンプレートは特定のランタイム用に調整されており、その規則に従います。テンプレートを使用すると、関数プロジェクトを自動的に開始できます。

次のランタイムのテンプレートが利用可能です。

6.12.1. Node.js コンテキストオブジェクトのリファレンス
リンクのコピー

context オブジェクトには、関数開発者が利用可能なプロパティーが複数あります。これらのプロパティーにアクセスすると、HTTP 要求に関する情報が提供され、出力がクラスターログに書き込まれます。

6.12.1.1. log
リンクのコピー

出力をクラスターロギングに書き込むために使用可能なロギングオブジェクトを提供します。ログは Pino logging API に準拠します。

ログの例

function handle(context) {
  context.log.info(“Processing customer”);
}

function handle(context) {
  context.log.info(“Processing customer”);
}

Copy to Clipboard

Toggle word wrap

kn func invoke コマンドを使用して、この関数にアクセスできます。

コマンドの例

kn func invoke --target 'http://example.function.com'

$ kn func invoke --target 'http://example.function.com'

Copy to Clipboard

Toggle word wrap

出力例

{"level":30,"time":1604511655265,"pid":3430203,"hostname":"localhost.localdomain","reqId":1,"msg":"Processing customer"}

{"level":30,"time":1604511655265,"pid":3430203,"hostname":"localhost.localdomain","reqId":1,"msg":"Processing customer"}

Copy to Clipboard

Toggle word wrap

ログレベルは、fatal、error、warn、info、debug、trace、または silent のいずれかに設定できます。これを実行するには、config コマンドを使用してこれらの値のいずれかを環境変数 FUNC_LOG_LEVEL に割り当てて、logLevel の値を変更します。

6.12.1.2. query
リンクのコピー

要求のクエリー文字列 (ある場合) をキーと値のペアとして返します。これらの属性はコンテキストオブジェクト自体にも表示されます。

サンプルクエリー

function handle(context) {
  // Log the 'name' query parameter
  context.log.info(context.query.name);
  // Query parameters are also attached to the context
  context.log.info(context.name);
}

function handle(context) {
  // Log the 'name' query parameter
  context.log.info(context.query.name);
  // Query parameters are also attached to the context
  context.log.info(context.name);
}

Copy to Clipboard

Toggle word wrap

kn func invoke コマンドを使用して、この関数にアクセスできます。

コマンドの例

kn func invoke --target 'http://example.com?name=tiger'

$ kn func invoke --target 'http://example.com?name=tiger'

Copy to Clipboard

Toggle word wrap

出力例

{"level":30,"time":1604511655265,"pid":3430203,"hostname":"localhost.localdomain","reqId":1,"msg":"tiger"}

{"level":30,"time":1604511655265,"pid":3430203,"hostname":"localhost.localdomain","reqId":1,"msg":"tiger"}

Copy to Clipboard

Toggle word wrap

6.12.1.3. ボディー
リンクのコピー

要求ボディー (ある場合) を返します。要求ボディーに JSON コードが含まれる場合には、属性は直接利用できるように解析されます。

ボディーの例

function handle(context) {
  // log the incoming request body's 'hello' parameter
  context.log.info(context.body.hello);
}

function handle(context) {
  // log the incoming request body's 'hello' parameter
  context.log.info(context.body.hello);
}

Copy to Clipboard

Toggle word wrap

curl コマンドを使用してこの関数を呼び出すことができます。

コマンドの例

kn func invoke -d '{"Hello": "world"}'

$ kn func invoke -d '{"Hello": "world"}'

Copy to Clipboard

Toggle word wrap

出力例

{"level":30,"time":1604511655265,"pid":3430203,"hostname":"localhost.localdomain","reqId":1,"msg":"world"}

{"level":30,"time":1604511655265,"pid":3430203,"hostname":"localhost.localdomain","reqId":1,"msg":"world"}

Copy to Clipboard

Toggle word wrap

6.12.1.4. ヘッダー
リンクのコピー

HTTP 要求ヘッダーをオブジェクトとして返します。

ヘッダーの例

function handle(context) {
  context.log.info(context.headers["custom-header"]);
}

function handle(context) {
  context.log.info(context.headers["custom-header"]);
}

Copy to Clipboard

Toggle word wrap

kn func invoke コマンドを使用して、この関数にアクセスできます。

コマンドの例

kn func invoke --target 'http://example.function.com'

$ kn func invoke --target 'http://example.function.com'

Copy to Clipboard

Toggle word wrap

出力例

{"level":30,"time":1604511655265,"pid":3430203,"hostname":"localhost.localdomain","reqId":1,"msg":"some-value"}

{"level":30,"time":1604511655265,"pid":3430203,"hostname":"localhost.localdomain","reqId":1,"msg":"some-value"}

Copy to Clipboard

Toggle word wrap

6.12.1.5. HTTP 要求
リンクのコピー

方法: HTTP 要求メソッドを文字列として返します。
httpVersion: HTTP バージョンを文字列として返します。
httpVersionMajor: HTTP メジャーバージョン番号を文字列として返します。
httpVersionMinor: HTTP マイナーバージョン番号を文字列として返します。

6.12.2. Typescript コンテキストオブジェクトの参照
リンクのコピー

context オブジェクトには、関数開発者が利用可能なプロパティーが複数あります。これらのプロパティーにアクセスすると、着信 HTTP 要求に関する情報が提供され、出力がクラスターログに書き込まれます。

6.12.2.1. log
リンクのコピー

出力をクラスターロギングに書き込むために使用可能なロギングオブジェクトを提供します。ログは Pino logging API に準拠します。

ログの例

export function handle(context: Context): string {
    // log the incoming request body's 'hello' parameter
    if (context.body) {
      context.log.info((context.body as Record<string, string>).hello);
    } else {
      context.log.info('No data received');
    }
    return 'OK';
}

export function handle(context: Context): string {
    // log the incoming request body's 'hello' parameter
    if (context.body) {
      context.log.info((context.body as Record<string, string>).hello);
    } else {
      context.log.info('No data received');
    }
    return 'OK';
}

Copy to Clipboard

Toggle word wrap

kn func invoke コマンドを使用して、この関数にアクセスできます。

コマンドの例

kn func invoke --target 'http://example.function.com'

$ kn func invoke --target 'http://example.function.com'

Copy to Clipboard

Toggle word wrap

出力例

{"level":30,"time":1604511655265,"pid":3430203,"hostname":"localhost.localdomain","reqId":1,"msg":"Processing customer"}

{"level":30,"time":1604511655265,"pid":3430203,"hostname":"localhost.localdomain","reqId":1,"msg":"Processing customer"}

Copy to Clipboard

Toggle word wrap

6.12.2.2. query
リンクのコピー

要求のクエリー文字列 (ある場合) をキーと値のペアとして返します。これらの属性はコンテキストオブジェクト自体にも表示されます。

サンプルクエリー

export function handle(context: Context): string {
      // log the 'name' query parameter
    if (context.query) {
      context.log.info((context.query as Record<string, string>).name);
    } else {
      context.log.info('No data received');
    }
    return 'OK';
}

export function handle(context: Context): string {
      // log the 'name' query parameter
    if (context.query) {
      context.log.info((context.query as Record<string, string>).name);
    } else {
      context.log.info('No data received');
    }
    return 'OK';
}

Copy to Clipboard

Toggle word wrap

kn func invoke コマンドを使用して、この関数にアクセスできます。

コマンドの例

kn func invoke --target 'http://example.function.com' --data '{"name": "tiger"}'

$ kn func invoke --target 'http://example.function.com' --data '{"name": "tiger"}'

Copy to Clipboard

Toggle word wrap

出力例

{"level":30,"time":1604511655265,"pid":3430203,"hostname":"localhost.localdomain","reqId":1,"msg":"tiger"}
{"level":30,"time":1604511655265,"pid":3430203,"hostname":"localhost.localdomain","reqId":1,"msg":"tiger"}

{"level":30,"time":1604511655265,"pid":3430203,"hostname":"localhost.localdomain","reqId":1,"msg":"tiger"}
{"level":30,"time":1604511655265,"pid":3430203,"hostname":"localhost.localdomain","reqId":1,"msg":"tiger"}

Copy to Clipboard

Toggle word wrap

6.12.2.3. ボディー
リンクのコピー

要求ボディー (ある場合) を返します。要求ボディーに JSON コードが含まれる場合には、属性は直接利用できるように解析されます。

ボディーの例

export function handle(context: Context): string {
    // log the incoming request body's 'hello' parameter
    if (context.body) {
      context.log.info((context.body as Record<string, string>).hello);
    } else {
      context.log.info('No data received');
    }
    return 'OK';
}

export function handle(context: Context): string {
    // log the incoming request body's 'hello' parameter
    if (context.body) {
      context.log.info((context.body as Record<string, string>).hello);
    } else {
      context.log.info('No data received');
    }
    return 'OK';
}

Copy to Clipboard

Toggle word wrap

kn func invoke コマンドを使用して、この関数にアクセスできます。

コマンドの例

kn func invoke --target 'http://example.function.com' --data '{"hello": "world"}'

$ kn func invoke --target 'http://example.function.com' --data '{"hello": "world"}'

Copy to Clipboard

Toggle word wrap

出力例

{"level":30,"time":1604511655265,"pid":3430203,"hostname":"localhost.localdomain","reqId":1,"msg":"world"}

{"level":30,"time":1604511655265,"pid":3430203,"hostname":"localhost.localdomain","reqId":1,"msg":"world"}

Copy to Clipboard

Toggle word wrap

6.12.2.4. ヘッダー
リンクのコピー

HTTP 要求ヘッダーをオブジェクトとして返します。

ヘッダーの例

export function handle(context: Context): string {
    // log the incoming request body's 'hello' parameter
    if (context.body) {
      context.log.info((context.headers as Record<string, string>)['custom-header']);
    } else {
      context.log.info('No data received');
    }
    return 'OK';
}

export function handle(context: Context): string {
    // log the incoming request body's 'hello' parameter
    if (context.body) {
      context.log.info((context.headers as Record<string, string>)['custom-header']);
    } else {
      context.log.info('No data received');
    }
    return 'OK';
}

Copy to Clipboard

Toggle word wrap

curl コマンドを使用してこの関数を呼び出すことができます。

コマンドの例

curl -H'x-custom-header: some-value’' http://example.function.com

$ curl -H'x-custom-header: some-value’' http://example.function.com

Copy to Clipboard

Toggle word wrap

出力例

{"level":30,"time":1604511655265,"pid":3430203,"hostname":"localhost.localdomain","reqId":1,"msg":"some-value"}

{"level":30,"time":1604511655265,"pid":3430203,"hostname":"localhost.localdomain","reqId":1,"msg":"some-value"}

Copy to Clipboard

Toggle word wrap

6.12.2.5. HTTP 要求
リンクのコピー

方法: HTTP 要求メソッドを文字列として返します。
httpVersion: HTTP バージョンを文字列として返します。
httpVersionMajor: HTTP メジャーバージョン番号を文字列として返します。
httpVersionMinor: HTTP マイナーバージョン番号を文字列として返します。

トップに戻る

6.12. 関数開発リファレンスガイド

6.12.1. Node.js コンテキストオブジェクトのリファレンス
リンクのコピー

6.12.1.1. log
リンクのコピー

6.12.1.2. query
リンクのコピー

6.12.1.3. ボディー
リンクのコピー

6.12.1.4. ヘッダー
リンクのコピー

6.12.1.5. HTTP 要求
リンクのコピー

6.12.2. Typescript コンテキストオブジェクトの参照
リンクのコピー

6.12.2.1. log
リンクのコピー

6.12.2.2. query
リンクのコピー

6.12.2.3. ボディー
リンクのコピー

6.12.2.4. ヘッダー
リンクのコピー

6.12.2.5. HTTP 要求
リンクのコピー

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

多様性を受け入れるオープンソースの強化

会社概要

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

6.12. 関数開発リファレンスガイド

6.12.1. Node.js コンテキストオブジェクトのリファレンスリンクのコピーリンクがクリップボードにコピーされました!

6.12.1.1. logリンクのコピーリンクがクリップボードにコピーされました!

6.12.1.2. queryリンクのコピーリンクがクリップボードにコピーされました!

6.12.1.3. ボディーリンクのコピーリンクがクリップボードにコピーされました!

6.12.1.4. ヘッダーリンクのコピーリンクがクリップボードにコピーされました!

6.12.1.5. HTTP 要求リンクのコピーリンクがクリップボードにコピーされました!

6.12.2. Typescript コンテキストオブジェクトの参照リンクのコピーリンクがクリップボードにコピーされました!

6.12.2.1. logリンクのコピーリンクがクリップボードにコピーされました!

6.12.2.2. queryリンクのコピーリンクがクリップボードにコピーされました!

6.12.2.3. ボディーリンクのコピーリンクがクリップボードにコピーされました!

6.12.2.4. ヘッダーリンクのコピーリンクがクリップボードにコピーされました!

6.12.2.5. HTTP 要求リンクのコピーリンクがクリップボードにコピーされました!

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

多様性を受け入れるオープンソースの強化

会社概要

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

6.12.1. Node.js コンテキストオブジェクトのリファレンス
リンクのコピー

6.12.1.1. log
リンクのコピー

6.12.1.2. query
リンクのコピー

6.12.1.3. ボディー
リンクのコピー

6.12.1.4. ヘッダー
リンクのコピー

6.12.1.5. HTTP 要求
リンクのコピー

6.12.2. Typescript コンテキストオブジェクトの参照
リンクのコピー

6.12.2.1. log
リンクのコピー

6.12.2.2. query
リンクのコピー

6.12.2.3. ボディー
リンクのコピー

6.12.2.4. ヘッダー
リンクのコピー

6.12.2.5. HTTP 要求
リンクのコピー