Function Compute:HTTPトリガーを使用して関数を呼び出す

使用上の注意

Function Compute 3.0では、カスタムランタイムおよびカスタムコンテナランタイムで実行される関数のHTTPトリガーは、Function Compute 2.0のHTTPトリガーと同じです。 ただし、標準ランタイムで実行される関数のHTTPトリガーは、Function Compute 2.0のHTTPトリガーとは大きく異なります。 このトピックでは、HTTPトリガーを使用して標準ランタイムで関数を呼び出す方法について説明します。

呼び出しプロセス

クライアントが関数URLを呼び出すと、function Computeはリクエストをイベントオブジェクトのイベントにマッピングし、イベントを関数に渡します。 次いで、機能応答は、HTTP応答にマッピングされる。 Function Computeは、関数URLを介してHTTP応答をクライアントに送信します。

リクエスト構造体

リクエスト構造体の形式

次のサンプルコードは、リクエストの構造体形式を示しています。

{
    "version": "v1",
    "rawPath": "/example",
    "body": "Hello FC!",
    "isBase64Encoded": false,
    "headers": {
        "header1": "value1",
        "header2": "value1,value2"
    },
    "queryParameters": {
        "parameter1": "value1",
        "parameter2": "value1,value2"
    },
    "requestContext": {
        "accountId": "123456*********",
        "domainName": "<http-trigger-id>.<region-id>.fcapp.run",
        "domainPrefix": "<http-trigger-id>",
        "http": {
            "method": "GET",
            "path": "/example",
            "protocol": "HTTP/1.1",
            "sourceIp": "11.11.11.**",
            "userAgent": "PostmanRuntime/7.32.3"
        },
        "requestId": "1-64f6cd87-*************",
        "time": "2023-09-05T06:41:11Z",
        "timeEpoch": "1693896071895"
    }
}

次の表に、パラメーターを示します。

Base64エンコードメカニズム

Function ComputeがHTTPリクエストをイベントオブジェクトのeventにマッピングするとき、Function ComputeはリクエストヘッダーのContent-Typeの値に基づいてHTTPボディに対してBase64エンコーディングを実行するかどうかを決定します。

Content-Typeの値がテキストタイプを示している場合、Function Computeはレスポンスボディに対してBase64エンコードを実行しません。 そうでなければ、応答本文はBase64-encodedされる。

テキストタイプを示すContent-Type値:

• text/*

• application/json

• application/ld+json

• application/xhtml+xml

• application/xml

• application/atom+xml

• application/javascript

レスポンス構造体

レスポンスstruct形式

関数がレスポンスを返すと、function Computeはレスポンスを解析し、HTTPレスポンスに変換します。 次のサンプルコードは、解析されたレスポンス構造体の形式を示しています。

{
    "statusCode": 200,
    "headers": {
        "Content-Type": "application/json",
        "Custom-Header-1": "Custom Value"
    },
    "isBase64Encoded": "false",
    "body": "{\"message\":\"Hello FC!\"}"
}

Function Computeの解析ロジック

Function Computeは応答を解析し、HTTP応答を作成してクライアントに返します。

• 関数がstatusCodeを含む有効なJSONオブジェクトを返した場合、function Computeは次のロジックに基づいてレスポンスを解析します。

  • statusCode: この関数は、JSONオブジェクトのstatusCodeの値を返します。

  • Content-Type: この関数は、JSONオブジェクトのContent-Typeの値を返します。 デフォルトでは、JSONオブジェクトにContent-Typeが含まれていない場合、Content-Typeはapplication/jsonです。

  • body: レスポンスボディ。 この関数は、JSONオブジェクトのbodyの値を返します。

  • isBase64Encoded: この関数は、JSONオブジェクトでisBase64Encodedの値を返します。 JSONオブジェクトにisBase64Encodedがない場合、デフォルト値はfalseです。

• 関数がstatusCodeを含まない有効なJSONオブジェクトを返した場合、または有効なJSONオブジェクトが返されなかった場合、function Computeは次の仮定を立てて応答構造体を構築します。

  • statusCode: デフォルト値は200です。

  • Content-Type: デフォルト値はapplication/jsonです。

  • body: 応答本文。コード内の戻り値のデータです。

  • isBase64Encoded: デフォルト値はfalseです。

Function Computeは、関数レスポンス構造体をHTTPレスポンスにマップし、次のロジックに基づいてクライアントに返します。

• statusCodeは、HTTPレスポンスのステータスコードにマッピングされます。

• headersはHTTPレスポンスヘッダーにマッピングされます。

• bodyはHTTPレスポンスボディにマップされます。 isBase64Encodedが存在し、値がtrueの場合、bodyがBase64-decodedされ、HTTPレスポンスボディにマップされます。

例

このセクションでは、関数の出力を関数応答構造体およびHTTP応答にマッピングする例を示します。 クライアントがHTTPトリガー関数を呼び出すと、HTTP応答が返されます。

{
  "statusCode"： "20"、
  "body": "Hello World!" 、
  "headers"：{
    "content-type": "application/json"
  },
  "isBase64Encoded": false
} 

HTTP/1.1 200 OK
Content-Disposition: attachment
Content-Length: 12
Content-Type: application/json
X-Fc-Request-Id: 1-64f6d6e7-e01edb1cce58240ed59b59d9
Date: Tue, 05 Sep 2023 07:21:11 GMT

Hello World!

{
  "statusCode"： "20"、
  "body": "{\" message\": \" Hello World!\"}" 、
  "headers"：{
    "content-type": "application/json"
  },
  "isBase64Encoded": false
} 

HTTP/1.1 200 OK
Content-Disposition: attachment
Content-Length: 27
Content-Type: application/json
X-Fc-Request-Id: 1-64f6d867-7302fc1ac6338b6fd2adb782
Date: Tue, 05 Sep 2023 07:27:35 GMT

{"message": "Hello World!"}

{
   "statusCode": 201,
    "headers": {
        "Content-Type": "application/json",
        "My-Custom-Header": "Custom Value"
    },
    "body": {
        "message": "Hello, world!"
    },
    "isBase64Encoded": false
}

{
   "statusCode": 201,
    "headers": {
        "Content-Type": "application/json",
        "My-Custom-Header": "Custom Value"
    },
    "body": {
        "message": "Hello, world!"
    },
    "isBase64Encoded": false
}

HTTP/1.1 200 OK
Content-Disposition: attachment
Content-Length: 27
Content-Type: application/json
Custom-Header-1: Custom Value
X-Fc-Request-Id: 1-64f6dcb3-e787580749d3ba13b047ce14
Date: Tue, 05 Sep 2023 07:45:55 GMT

{"message": "Hello world!"}

Base64デコードメカニズム

関数出力が有効なJSONオブジェクトで、isBase64Encodedの値がtrueの場合、function ComputeはJSONオブジェクトのbodyに対してBase64デコードを実行し、HTTPレスポンスボディを使用してデコードされたデータをクライアントに返します。

bodyのデコードに失敗した場合、Function Computeはエラーを報告せず、bodyの値をクライアントに直接返します。

HTTPレスポンスヘッダー

HTTPトリガーを使用して関数を呼び出す場合、レスポンスヘッダーには、function Computeによって自動的に追加されるレスポンスヘッダーX-Fc-Request-Idが含まれます。 応答ヘッダは、要求の一意の識別子である。 X-Fc-Request-Idを除いて、Function Computeは他のレスポンスヘッダーを自動的に追加しません。

コードでカスタム応答ヘッダーを返すことができます。 ただし、X-Fc- で始まるレスポンスヘッダーと、Function Computeの次の予約済みレスポンスヘッダーはサポートされていません。

• connection

• content-length

• date

• keep-alive

• server

• content-disposition

レスポンスヘッダーで予約済みヘッダーを使用する場合、Function Computeはレスポンスヘッダーを無視します。

エラー処理

関数エラーが発生した場合、関数がAPI呼び出しによって呼び出された場合、エラーメッセージが返されます。 HTTPリターンコードは200です。 たとえば、次のサンプルコードは、PythonのModuleNotFoundエラーに対する応答です。

{
    "errorMessage": "Unable to import module 'index'",
    "errorType": "ImportModuleError",
    "stackTrace": [
        "ModuleNotFoundError: No module named 'not_exist_module'"
    ]
}

ただし、関数がHTTPトリガーによって呼び出された場合、function Computeはエラーメッセージを非表示にし、HTTPリターンコード502のInternal Server errorを直接返します。 次のサンプルコードは、HTTPレスポンスの例を示しています。

悪いゲートウェイ502

HTTP/1.1 502 Bad Gateway
Content-Disposition: attachment
Content-Type: application/json
X-Fc-Request-Id: 1-64f6df91-fe144d52e4fd27afe3d8dd6f
Date: Tue, 05 Sep 2023 07:58:09 GMT
Content-Length: 21

Internal Server Error

この場合、リクエストによって返されるX-Fc-Request-Idを使用して、ログ内の特定のエラーメッセージを見つけることができます。

コード開発

Function Compute 3.0の標準ランタイムでコードを記述する場合は、ハンドラに関する次のトピックを参照してください。

• Node.jsハンドラー

• Pythonハンドラー

• PHPハンドラー

• Javaハンドラー

• C# ハンドラー

• Goハンドラー