Function Compute: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"
    }
}

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

リクエストマッピングロジック

Function Compute は、受信 HTTP リクエストをイベントオブジェクトにマッピングしてから、そのイベントオブジェクトを関数のハンドラに渡します。マッピングロジックは次のとおりです。

• HTTP リクエストのヘッダーは、event headers にマッピングされます。

• HTTP リクエストのクエリ文字列パラメーターは、queryParameters にマッピングされます。

• HTTP リクエストのコンテキスト情報は、requestContext にマッピングされます。

• POST リクエストのリクエスト本文は、body にマッピングされます。

リクエストマッピングの例

GET /?parameter1=value1&parameter2=value2 HTTP/1.1

{
  "version": "v1",
  "rawPath": "/",
  "headers": {
    "Accept": "*/*",
    "User-Agent": "CurlHttpClient"
  },
  "queryParameters": {
    "parameter1": "value1",
    "parameter2": "value2"
  },
  "body": "",
  "isBase64Encoded": true,
  "requestContext": {
    "accountId": "1327************",
    "domainName": "example.cn-hangzhou.fcapp.run",
    "domainPrefix": "example",
    "requestId": "1-67aee50c-********-************",
    "time": "2025-02-14T06:39:08Z",
    "timeEpoch": "1739515148145",
    "http": {
      "method": "GET",
      "path": "/",
      "protocol": "HTTP/1.1",
      "sourceIp": "40.XX.XX.XX",
      "userAgent": "CurlHttpClient"
    }
  }
}

curl -v "https://example.cn-hangzhou.fcapp.run?parameter1=value1&parameter2=value2"

POST / HTTP/1.1
Content-Type: application/json

{
  "version": "v1",
  "rawPath": "/",
  "headers": {
    "Accept": "*/*",
    "Content-Length": "20",
    "Content-Type": "application/json",
    "User-Agent": "curl/8.7.1"
  },
  "queryParameters": {},
  "body": "{\"message\": \"Hello\"}",
  "isBase64Encoded": false,
  "requestContext": {
    "accountId": "1327************",
    "domainName": "example.cn-hangzhou.fcapp.run",
    "domainPrefix": "example",
    "requestId": "1-67aee50c-********-************",
    "time": "2025-02-14T06:39:08Z",
    "timeEpoch": "1739515148145",
    "http": {
      "method": "POST",
      "path": "/",
      "protocol": "HTTP/1.1",
      "sourceIp": "40.XX.XX.XX",
      "userAgent": "CurlHttpClient"
    }
  }
}

レスポンス構造体のフォーマット

レスポンス構造体のフォーマットは次のとおりです。Function Compute は関数の出力を解析し、レスポンス構造体に変換し、この構造体を HTTP レスポンスにマッピングします。

{
    "statusCode": 200,
    "headers": {
        "Content-Type": "application/json",
        "Custom-Header-1": "Custom Value" // カスタムヘッダー
    },
    "isBase64Encoded": false,
    "body": "{\"message\":\"Hello FC!\"}"
}

{
  "statusCode": 200,
  "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": 200,
  "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 201 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 デコードメカニズム

関数が isBase64Encoded パラメーターの値が true である有効な JSON を返す場合、Function Compute は JSON body に対して Base64 デコードを実行し、デコードされたデータを HTTP 応答本文にマッピングします。

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

HTTP 応答ヘッダー

関数 URL の呼び出しでは、Function Compute によって自動的に追加される応答ヘッダー 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'", // モジュール 'index' をインポートできません
    "errorType": "ImportModuleError", // モジュールのインポートエラー
    "stackTrace": [
        "ModuleNotFoundError: No module named 'not_exist_module'" // モジュール not_exist_module という名前のモジュールが見つかりません
    ]
}

ただし、関数 URL 呼び出しの場合、Function Compute はエラーメッセージを非表示にし、Internal Server Error のみを返します。HTTP ステータスコードは 502 です。次のサンプルコードは例を示しています。

HTTP/1.1 502 Bad Gateway
Content-Disposition: attachment // 添付ファイル
Content-Type: application/json // アプリケーション/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 レスポンスヘッダーを使用すると、関連するログを効率的に特定し、リクエストに関連付けられたエラーメッセージを識別できます。