Version: 2.8.1
列表
在服務列表頁面,可以清楚看到所有的服務 名稱
、主機
、標籤
、建立時間
以及 建立者
的資訊,並且可以新增服務以及對既有服務做編輯或刪除的動作。如果對某項服務想知道更詳細的資訊,可以點擊服務名稱,即可得到更詳細的訊息以及監控的資訊。
#
新增服務從網站左邊 Menu 中點選
服務列表
頁面,進入服務列表的畫面。點選右上角的
新增
後,填入相關資訊後送出。
#
欄位配置說明變數 | 類型 | 預設值 | 說明 | 必填 |
---|---|---|---|---|
name | string | 服務名稱。 | V | |
retries | number | 5 | 對於上游服務連接失敗重試次數。 此欄位接受輸入的值區間為 0 至 32767。 | |
protocol | string | http | 選擇對上游服務溝通的協定。可以選擇 grpc 、 grpcs 、 http 、 https 、 tcp 、 tls 、 tls_passthrough 以及 udp 。 | V |
host | string | 上游服務伺服器主機。 可選擇一般的新增服務,或是新增現有的上游服務。 | V | |
port | number | 80 | 上游服務伺服器通訊埠。 此欄位接受輸入的值區間為 0 至 65535。 | V |
path | string | 對上游服務送請求時的路徑。 填入的路徑起始值必須為 / ,例如 /api/v1 。 | ||
connect_timeout | number | 60000 | 設定對連線至上游服務的逾時時間(單位為毫秒)。 此欄位接受輸入的值區間為 1 至 2147483646。 | |
write_timeout | number | 60000 | 用於將請求傳輸到上游服務器的兩個連續寫入操作之間的逾時時間(單位為毫秒)。 此欄位接受輸入的值區間為 1 至 2147483646。 | |
read_timeout | number | 60000 | 用於將請求傳輸到上游服務器的兩個連續讀取操作之間的逾時時間(單位為毫秒)。 此欄位接受輸入的值區間為 1 至 2147483646。 | |
tags | array of string | 可填入任意字串來做分類使用。 | ||
client_certificate | string | 當對上游服務做 TLS handshaking 時可做為用戶端憑證做認證使用。必須填入憑證的ID (UUID 格式)。 | ||
tls_verify | boolean | null | 是否啟用上游服務器 TLS 證書的驗證。如果設置為 null ,則遵循 Nginx 默認值。請注意,若啟用 TLS 證書驗證,需檢查 protocol 是否正確(例如:不可以選擇 http)。 | |
tls_verify_depth | number | null | 驗證上游服務器的 TLS 證書時的最大鍊深度。如果設置為 null ,則遵循 Nginx 默認值。此欄位接受輸入的值區間為 0 至 64。 | |
ca_certificates | array of string | 可傳入多組 CA 證書的 ID (UUID格式),每個 ID 視為一個 string。 用於在驗證上游服務器的 TLS 證書時構建信任庫的 CA 證書 的 ID (UUID格式)。如果要使用 Nginx 默認值時,請設置為 null 。如果不指定 Nginx 中的默認 CA 列表,且啟用 TLS 驗證的情況下,那麼與上游服務器的 handshake 總是會失敗(因為不信任 CA)。 | ||
enabled | boolean | true | 服務是否設定為上架狀態。如果設置為 false ,代理行為會像是其下的路由都不存在一樣。(404) |
#
上/下架服務可以在列表的頁面,切換「啟用」按鈕,顏色亮起便是上架,再點擊一下就是下架。
上架代表此服務可以透過 GOC API Gateway 存取.下架就代表該服務無法透過 GOC API Gateway 來存取。
#
預覽頁面點擊服務名稱後即會跳出預覽視窗。可以看到服務的服務拓樸、詳細資訊和其擁有的路由資訊以及插件資訊,較為特殊的是有服務拓樸、監控資訊。
服務拓樸會用視覺化的方式顯示整個服務、路由、插件之間的關係。
詳細資訊則是會顯示目前服務所有的設定資訊。
監控頁面在選擇時間區間後,即會顯示此服務底下的平均回應時間以及狀態碼回應次數。
#
編輯及刪除如想對某個特定服務做編輯或刪除可按右邊的動作按鈕。
按下刪除鍵後會出現確認對話視窗,選擇刪除即可刪除。
選擇列表左方的框,再選擇右上角的垃圾筒,可以一次多筆刪除。
note
多筆刪除會直接動作,不會有確認對話框出現。
在刪除服務之前,請先刪除服務下的所有路由,如果服務下還存有路由,則服務無法被刪除,會跳出錯誤訊息。