本頁適用於 Apigee 和 Apigee Hybrid。
查看
Apigee Edge 說明文件。
變更 API Proxy 後,您可以將其儲存為新修訂版本,並部署至叢集。
關於部署
下圖顯示 Apigee 上 API 代理程式修訂版本的部署生命週期。
API Proxy 修訂版本限制
以下限制適用於 API Proxy 修訂版本:
- 如果您對 API Proxy 進行任何變更,則必須將其部署為新修訂版本。
- 部署 API proxy 後,修訂版本將會變成唯讀。您無法變更 API Proxy 修訂版本 (例如進行漸進式變更);變更修訂版本的唯一方法,就是建立並部署新修訂版本。
- 代理程式套件只能以完整形式部署。如果您變更個別片段或政策,MP 仍會部署整個 Proxy 套件。
- 如果您的 Apigee 用途會區分標準和可擴充 Proxy,當您部署修訂版本將 API Proxy 從標準 Proxy 變更為可擴充 Proxy 時:
- 可能會產生費用。如果您是即付即用客戶,請參閱「即付即用授權」。如果您是訂閱方案客戶,請查看方案詳細資料。
- 部署作業需要額外時間。在部署期間,API 呼叫流程不會中斷,但您無法部署、取消部署或刪除 Proxy。此外,在部署期間,您也無法刪除目前或新的修訂版本。您可以變更 API Proxy 和建立新修訂版本。
零停機部署
所有成功部署至 Apigee 的 API Proxy 都是零停機時間部署。API Proxy 部署作業會依照以下順序進行:
- API Proxy
/hello
的修訂版本 1 已部署並處理流量。 - 已部署
/hello
的修訂版本 2。 - 修訂版本 2 會部署至執行階段平面中的訊息處理器。
- 未部署修訂版本 1。
API Proxy 修訂版本部署作業現已完成,且沒有任何服務中斷時間。
查看部署狀態
在 Apigee 上部署 API Proxy 後,並不會立即可供使用。在執行階段平面中,API 代理程式需要花費時間才能同步處理所有 MP。不過,Apigee 提供的工具可提供有關 API 代理程式修訂版本狀態的相關資訊。
傳統版 Apigee UI
Apigee UI 中有多個檢視畫面,可提供 API 代理程式的部署狀態。
Apigee UI 檢視畫面 | 步驟與說明 |
---|---|
Proxy |
Apigee UI 會使用下列圖示,快速顯示每個 API Proxy 的狀態:
如要查看狀態圖示,請按一下「開發」分頁。 或者,您也可以依序選取「Develop」>「API Proxies」,然後點選 API Proxy。 |
Apigee API
如要查看環境中 API 代理程式修訂版本的部署狀態,請使用下列 API 呼叫:
curl "https://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/apis/$API/revisions/$REV/deployments" \ -X GET \ -H "Authorization: Bearer $TOKEN"
其中 $TOKEN
會設為您的 OAuth 2.0 存取權憑證,如取得 OAuth 2.0 存取權憑證一文所述。如要瞭解本範例中使用的 curl
選項,請參閱「使用 curl」。如要瞭解所使用的環境變數,請參閱「為 Apigee API 要求設定環境變數」。
以下提供回應範例。這個範例顯示在 test
環境中部署的 helloworld
API Proxy 修訂版本 1
的部署狀態:
{ "environment": "test", "apiProxy": "helloworld", "revision": "1", "deployStartTime": "1559149080457", "pods": [ { "podName": "apigee-runtime-myorg-test-f8bdf9d-2s72w", "deploymentStatus": "deployed", "statusCodeDetails": "Deployment Success", "podStatus": "active", "podStatusTime": "1595357668001" } ], "state": "READY" }
詳情請參閱 API 代理修訂版本環境部署 API。
gcloud
如要查看環境中 API Proxy 修訂版本的部署狀態,請使用下列 gcloud 指令:
gcloud alpha apigee deployments describe --api=$API --environment=$ENV
如需進一步瞭解範例中使用的環境變數,以及相關說明,請參閱「開始使用 Apigee 搭配 gcloud」。
以下提供回應範例。這個範例顯示在 test
環境中部署的 helloworld
API proxy 修訂版本 1
的部署狀態:
Using Apigee organization `my-org` Using deployed revision `1` apiProxy: helloworld deployStartTime: '1598032332802' environment: test pods: - deploymentStatus: deployed podName: apigee-runtime-myorg-test-f8bdf9d-2s72w podStatus: active podStatusTime: '1598302128087' statusCodeDetails: Deployment Success revision: '1' state: READY
詳情請參閱「說明部署作業 CLI」。
查看 Proxy 部署用量
機構內的 API 代理程式用量可能會受到部署配額的限制,也就是一次可使用的部署單位數量上限。詳情請參閱您的授權 (Pay-as-you-go或訂閱)。您可以在 Cloud 控制台中的 Apigee UI 的多個位置查看貴機構的 Proxy 部署用量,如下所述。
在 Apigee 總覽頁面查看部署用量
如要在 Apigee 的「總覽」頁面查看 API Proxy 部署用量,請按照下列步驟操作:
- 在 Google Cloud 控制台的 Apigee UI 中,開啟「總覽」頁面。
- 您可以使用「Proxy Usage」資訊卡,一覽貴機構的 Proxy 部署用量,這張資訊卡會顯示貴機構的下列資訊:
- 已建立的 Proxy 總數:已建立的 API Proxy 總數,包括已部署和未部署的 Proxy。
- 已部署的 Proxy:機構中所有環境中已部署的 API Proxy 總數。
- Proxy deployment units:在貴機構中部署的 API Proxy 或共用流程修訂版本總數。每個環境和每個執行個體的每個部署作業都會計為一個單位。
- Proxy 和共用流程相對於限制的部署數量:機構中部署的 API Proxy 和共用流程總數,相對於貴機構類型的限制。
- 可擴充的部署單位:貴機構中部署的可擴充 API 代理程式修訂版本數量。每個環境和每個執行個體的每個部署作業都會計為一個單位。
- 標準部署單位:貴機構中部署的標準 API 代理程式修訂版本數量。每個環境和每個執行個體的每個部署作業都會計為一個單位。
在「API Proxy」頁面查看部署用量
如要透過「API Proxy」頁面查看 API Proxy 部署用量,請按照下列步驟操作:
- 在 Google Cloud 控制台的 Apigee UI 中,開啟「API Proxies」頁面。
- 「API Proxy」頁面會顯示下列資訊:
- 已建立的 Proxy 總數:貴組織中開發的 API Proxy 總數,包括已部署和未部署的 Proxy。
- 已部署的 Proxy:在貴機構的所有環境中,已部署的 API Proxy 修訂版本總數。
- Proxy 部署單位:在貴機構的所有環境中部署的 API Proxy 或共用流程修訂版本總數。每個環境和每個執行個體的每個部署作業都會計為一個單位。
- 可擴充的 Proxy 部署單位:在貴機構的所有環境中部署的可擴充 API Proxy 修訂版本數量。每個環境和每個執行個體的每個部署作業都會計為一個單位。
- 標準 Proxy 部署單位:在貴機構的所有環境中部署的標準 API Proxy 修訂版本數量。每個環境和每個執行個體的每個部署作業都會計為一個單位。
在「Environments」(環境) 頁面查看部署用量
如要透過「環境」頁面查看 API Proxy 部署用量,請按照下列步驟操作:
- 在 Google Cloud 控制台中,開啟 Apigee UI 中的「Environments」頁面。
- 選取「環境」總覽分頁,即可針對所有環境顯示下列資訊:
- Proxy 部署單位總數:在貴機構的所有環境中部署的 API Proxy 或共用流程修訂版本總數。
- 可擴充的 Proxy 部署單位:在貴機構的所有環境中部署的可擴充 API Proxy 修訂版本數量。每個環境和每個執行個體的每個部署作業都會計為一個單位。
- 標準 Proxy 部署單位:在貴機構的所有環境中部署的標準 API Proxy 修訂版本數量。每個環境和每個執行個體的每個部署作業都會計為一個單位。
- 共用流程部署單位:在貴機構的所有環境中部署的共用流程修訂版本總數。每個環境和每個執行個體的每個部署作業都會計為一個單位。
- 如要查看單一環境的 Proxy 部署用量:
- 在「Environments」清單中,選取要查看詳細資料的環境名稱。
- 選取「Deployments」分頁,即可查看所選環境的部署單位用量。
後續步驟
瞭解如何部署:
|
瞭解如何解除部署:
|