Function Compute：HTTP觸發器調用函數

注意事項

在Function Compute3.0版中，Custom Runtime和Custom Container的HTTP觸發器行為與Function Compute2.0版一致，但標準運行時函數的HTTP觸發器與Function Compute2.0版有較大的差異。本文介紹的內容是如何在標準運行時使用HTTP觸發器調用函數。

調用函數流程

當用戶端調用函數URL時，Function Compute會將請求映射到事件對象event，再將event傳遞給函數。然後函數的響應將映射到一個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時，會根據要求標頭中的Content-Type類型判斷是否對HTTP Body進行Base64編碼。

當要求標頭中的Content-Type表示文本類型時，不會對響應體進行Base64編碼；否則，會對響應體進行Base64編碼。

Content-Type為文本類型的取值如下：

• text/*

• application/json

• application/ld+json

• application/xhtml+xml

• application/xml

• application/atom+xml

• application/javascript

響應結構體

響應結構體格式

當函數返迴響應時，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 Response返回給用戶端。

• 如果您的函數返回有效JSON並且包含statusCode欄位，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。

• 如果您的函數返回有效JSON但是沒有包含statusCode欄位，或者返回的不是有效JSON，Function Compute會做出以下假設，構造響應結構體。

  • statusCode：預設為200。

  • Content-Type：預設為application/json。

  • body：函數響應，即代碼中return的資料。

  • isBase64Encoded：預設為false。

Function Compute會將函數響應結構體映射成HTTP響應返回給用戶端，映射邏輯如下：

• statusCode映射為HTTP響應的狀態代碼。

• headers映射為HTTP回應標頭。

• body映射為HTTP響應體，如果存在isBase64Encoded且為true，則先將body進行Base64解碼，再映射到HTTP響應體。

樣本

以下樣本介紹了函數的輸出如何映射到函數響應結構體，以及函數響應結構體如何映射到最終的HTTP響應。當用戶端調用函數HTTP觸發器時，就可以看到HTTP響應。

{
  "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解碼機制

當函數輸出為有效JSON格式，且JSON中的isBase64Encoded欄位為true時，Function Compute會將JSON中的body欄位進行Base64解碼，再將解碼後的資料通過HTTP響應體返回給用戶端。

如果對body欄位解碼失敗，Function Compute不會報錯，而是直接將原始的body欄位的值返回給用戶端。

回應標頭（HTTP Response Header）

使用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會隱藏這些錯誤資訊，直接返回 Internal Server Error，HTTP返回碼為502。HTTP響應樣本如下：

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在日誌中尋找具體的報錯資訊。

代碼開發

在FC 3.0標準運行時中，編寫代碼時，請參考以下運行時請求處理常式（Handler） 文檔。

• Node.js請求處理常式

• Python請求處理常式

• PHP請求處理常式

• Java請求處理常式

• C#請求處理常式

• Go請求處理常式