ファンクションの呼出し

Fn ProjectのCLIを使用してOCI Functionsにデプロイされたファンクションを呼び出すには:

1. ファンクション開発者として開発環境にログインします。

2. ターミナル・ウィンドウで入力します:

   fn invoke <app-name> <function-name>

   ここでは:

   • <app-name>は、呼び出すファンクションを含むアプリケーションの名前です
   • <function-name>は呼び出す必要があるファンクションの名前です

   例:

   fn invoke helloworld-app helloworld-func

   出力:

   Hello World !

   ヒント
   
   

   引数と値をファンクションに渡す場合は、fn invokeコマンドにecho -n '<argument>=<value>'|を接頭辞として付加します

   ファンクションで引数と値がJSONと予想される場合は、有効なJSON形式を使用します。例:

   echo -n '{"name":"John"}' | fn invoke helloworld-app helloworld-func

   出力:

   Hello John !

Oracle Cloud Infrastructure CLIをインストールした場合、これを使用してファンクションを呼び出すAPIリクエストを送信できます。特に、Oracle Cloud InfrastructureのCLIを使用するとOracle Cloud Infrastructure認証が容易になります。Oracle Cloud Infrastructure CLIの使用方法の詳細は、コマンドライン・インタフェース(CLI)を参照してください。

これらの手順では、次のことを前提にしています:

• Oracle Cloud Infrastructure CLIをすでにインストールおよび構成している
• 開発環境用に構成されたファンクション開発者としてファンクションを呼び出す場合

Oracle Cloud Infrastructure CLIを使用してファンクションを呼び出すには:

1. ファンクション開発者として開発環境にログインします。

2. ターミナル・ウィンドウで入力します:

   oci fn function invoke --function-id <function-ocid> --file "<output-filepath>" --body "<request-parameters>"

   ここでは:

   • <function-ocid>は、呼び出すファンクションのOCIDです。ファンクションのOCIDを調べるには、fn inspectコマンドを使用してファンクションのidプロパティの値を参照します(ファンクションのリストを参照)。
   • <output-filepath>は、レスポンスを書き込むファイルのパスと名前です。レスポンスをstdoutに書き込むには、--file "-"を指定します
   • <request-parameters>は、オプションでファンクションに渡す引数と値を指定します。ファンクションで引数と値がJSONと予想される場合は、有効なJSON形式を使用します。たとえば、--body '{"name":"John"}'です。渡すリクエスト・パラメータがない場合でも、リクエストに--body ""を含める必要があります。

   例:

   • oci fn function invoke --function-id ocid1.fnfunc.oc1.phx.aaaa____uxoa --file "-" --body ""

     出力:

     Hello World !

   • oci fn function invoke --function-id ocid1.fnfunc.oc1.phx.aaaa____uxoa --file "-" --body '{"name":"John"}'

     出力:

     Hello John !

Oracle Cloud Infrastructure SDKが存在する言語でファンクションを呼び出すプログラムを作成する場合は、そのSDKを使用してファンクションを呼び出すAPIリクエストを送信することをお薦めします。特に、SDKを使用するとOracle Cloud Infrastructure認証が容易になります。

SDKを使用してファンクションを呼び出す場合、Oracle Cloud Infrastructure CLIのraw-requestコマンドの使用時に指定する呼出しエンドポイント全体は指定しません(ファンクションの呼出しエンドポイントの取得を参照)。かわりに、ファンクションの呼出しエンドポイントの最初の部分のみを指定します。たとえば、SDKを使用する場合は、ファンクションの呼出しエンドポイントをhttps://fht7ns4mn2q.us-phoenix-1.functions.oci.oraclecloud.com/20181201/functions/ocid1.fnfunc.oc1.phx.aaaa____uxoa/actions/invokeとして指定しないでください。かわりに、ファンクションの呼出しエンドポイントをhttps://fht7ns4mn2q.us-phoenix-1.functions.oci.oraclecloud.comとして指定します。

APIの使用およびリクエストの署名の詳細は、REST APIのドキュメントおよびセキュリティ資格証明を参照してください。SDKの詳細は、SDKおよびCLIを参照してください。

InvokeFunction API操作を使用してファンクションを呼び出します。

Oracle Cloud Infrastructure CLIのraw-requestコマンドを使用してファンクションを呼び出す場合、ファンクションの呼出しエンドポイントを指定する必要があります。

ファンクションの呼出しエンドポイントを取得するには:

1. ファンクション開発者として開発環境にログインします。

2. ターミナル・ウィンドウで入力します:

   fn inspect function <app-name> <function-name>

   ここでは:

   • <app-name>は、呼出しエンドポイントを取得するファンクションが含まれているアプリケーションの名前です
   • <function-name>は、呼出しエンドポイントを取得するファンクションの名前です

   例:

   fn inspect function helloworld-app helloworld-func

   出力:

   {
      "annotations": {
   		"fnproject.io/fn/invokeEndpoint": "https://fht7ns4mn2q.us-phoenix-1.functions.oci.oraclecloud.com/20181201/functions/ocid1.fnfunc.oc1.phx.aaaa____uxoa/actions/invoke",
   
   ...
   }

   ファンクションの呼出しエンドポイントは"fnproject.io/fn/invokeEndpoint"の値です。たとえば、"https://fht7ns4mn2q.us-phoenix-1.functions.oci.oraclecloud.com/20181201/functions/ocid1.fnfunc.oc1.phx.aaaa____uxoa/actions/invoke"(読みやすくするために省略)と入力します。

Oracle Cloud Infrastructure CLIをインストールした場合、これを使用してファンクションを呼び出すAPIリクエストを送信できます。特に、CLIを使用するとOracle Cloud Infrastructure認証が容易になります。Oracle Cloud Infrastructure CLIの使用方法の詳細は、コマンドライン・インタフェース(CLI)を参照してください。

これらの手順では、次のことを前提にしています:

• Oracle Cloud Infrastructure CLIをすでにインストールおよび構成している
• 開発環境用に構成されたファンクション開発者としてファンクションを呼び出す場合

Oracle Cloud Infrastructure CLIのraw-requestコマンドを使用してファンクションの呼出しエンドポイントに署名付きリクエストを送信することにより、OCIファンクションにデプロイされたファンクションを呼び出すには:

1. ファンクション開発者として開発環境にログインします。

2. ファンクションの呼出しエンドポイントを取得します(ファンクションの呼出しエンドポイントの取得を参照)。

   たとえば、"fnproject.io/fn/invokeEndpoint": "https://fht7ns4mn2q.us-phoenix-1.functions.oci.oraclecloud.com/20181201/functions/ocid1.fnfunc.oc1.phx.aaaa____uxoa/actions/invoke"(読みやすくするために省略)と入力します。

3. Oracle Cloud Infrastructure CLIのraw-requestコマンドを使用し、次のように入力して、署名付きPOSTリクエストをファンクションの呼出しエンドポイントに送信することによって、ファンクションを呼び出します:

   oci raw-request --http-method POST --target-uri <invoke-endpoint> --request-body "<request-parameters>"

   ここでは:

   • <invoke-endpoint>は、前のステップで取得したエンドポイントです。
   • <request-parameters>は、オプションでファンクションに渡す引数と値を指定します。ファンクションで引数と値がJSONと予想される場合は、有効なJSON形式を使用します。渡すリクエスト・パラメータがない場合でも、リクエストに--request-body ""を含める必要があります。

   例:

   • oci raw-request --http-method POST --target-uri https://fht7ns4mn2q.us-phoenix-1.functions.oci.oraclecloud.com/20181201/functions/ocid1.fnfunc.oc1.phx.aaaa____uxoa/actions/invoke --request-body ""

     出力:

     Hello World !

   • oci raw-request --http-method POST --target-uri https://fht7ns4mn2q.us-phoenix-1.functions.oci.oraclecloud.com/20181201/functions/ocid1.fnfunc.oc1.phx.aaaa____uxoa/actions/invoke --request-body '{"name":"John"}'

     出力:

     Hello John !

4. API署名キーを暗号化するためにパスフレーズを指定した場合は、プロンプトが表示されたらパスフレーズを入力します。

次の場合に、起動タイプとして「デタッチ済」を使用してファンクションを起動します。

• 実行に時間がかかるファンクションを起動する場合。
• ファンクションを非同期に実行して、ファンクションが呼び出された直後に、呼出しの結果を待たずに制御がコール元に返されるようにします。
• 成功した呼出しと失敗した呼出しの結果を送信する宛先を指定します。

デタッチされた起動により、長時間実行されるワークロード(大規模なETLタスク、AI/MLジョブ、統合など)は、同期起動タイムアウトによって制限されることなく終了できます。

oci fn function create --application-id <ocid> --display-name "fn_longer_demo" --image <image> --memory-in-mbs 256 \
  --detached-mode-timeout-in-seconds 1800 \
  --success-destination file://success-dest.json \
  --failure-destination file://failure-dest.json

ここでは:

• success-dest.jsonには、次のJSON文字列が含まれます。

  {"kind": "STREAM", "streamId": "ocid1.stream.oc1...."}

• failure-dest.jsonには、次のJSON文字列が含まれます。

  {"kind": "QUEUE", "queueId": "ocid1.queue.oc1....", "channelId": "failure1234"}

異なる宛先サービスに指定する属性については、APIドキュメントのSuccessDestinationDetailsおよびFailureDestinationDetailsを参照してください。

{
  "id": "01K1Q6K12C1BT01KRZJ000HKB9",
  "version": "1.0",
  "data": {
    "compartmentId": "ocid1.compartment.oc1..aaaaaaaa______jf4a",
    "functionId": "...",
    "applicationId": "...",
    "request": {
      "opcRequestId": "...",
      "fnCallId": "..."
    },
    "response": {
      "status": "200",
      "errorCode": null,
      "errorMessage": null,
      "timestamp": "2025-08-03T05:31:21.392988237Z"
    }
  }
}

{
    "id": "01J6BS40ZC000000000000H7Z0",
    "version": "1.0",
    "data":
    {
        "compartmentId": "ocid1.compartment.oc1..aaaaaaaa______jf4a",
        "functionId": "...",
        "applicationId": "...",
        "request": {
            "opcRequestId": "...",
            "fnCallId": "..."
        },
        "response": {
            "status": "502",
            "errorCode": "FunctionInvokeExecutionFailed",
            "errorMessage": "function failed",
            "timestamp": "2024-08-11T21:47:41.264Z"
        }
    }
}